Campaign
Properties description
id
Integer
Campaign unique identification.
name
String
Campaign name defined par user during creation
state
Enum
Current state of the campaign, it can take this values : - waiting - running - paused - completed - archived
account_id
Integer
Id of the account associated to the campaign
owner_account_id
Integer
Id of the owner account or parent account generally used for agency customer campaigns.
product_id
Integer
Id of the main product of the campaign (SmartCover, SmartRead, SmartPulse or Display).
start_at
Datetime
Start of the campaign, GMT timezone
stop_at
Datetime
Stop of the campaign, GMT timezone
impressions
Integer
Amount of ad impressions (eg to ad calls).
visible_impressions
Integer
Amount of ad displayed more than 1 second on the user screen.
clicks
Integer
Amount of clicks generated by the campaign
exposure_time
Integer
Amount of seconds when the ad is displayed (at minimum 50% of his content) on user screen.
created_at
Datetime
Creation date of the campaign, GMT timezone
updated_at
Datetime
Last update of the campaign, GMT timezone
deleted_at
Datetime
Field used for softdeleting the campaign. This property is null for active campaign.
Search campaigns
GET https://my.smartxsp.io/api/campaigns
Allows you to retrieve the list of campaigns according to the scope of the connected user as well as the input parameters. ⚠️ Please note that the list is limited to the last 1000 campaigns.
Query Parameters
String
Headers
Authorization*
String
The Bearer token you get during login process.
{
"success":true,
"data":{
"user":{
"id":1,
"name":"John Doe",
"email":"[email protected]",
"account_id":1,
"account":{
"id":1,
"name":"Account Name",
"account_type":"agency"
}
},
"campaigns":[
{
"id":1,
"name":"First campaign"
},
{
"id":2,
"name":"Second campaign"
}
]
},
"message":"Campaigns retrieved successfully."
}Get campaign details
GET https://my.smartxsp.io/api/campaigns/{campaign_id}
Retrieves campaign details.
Path Parameters
campaign_id*
String
The numeric id of the campaign
Headers
Authorization*
String
The Bearer token you get during login process.
{
"success": true,
"data": {
"id": 7028,
"name": "Demo Campaign 2025-08-25 16:40:59",
"state": "waiting",
"account_id": 1,
"owner_account_id": 1,
"product_id": 33,
"start_at": "2025-09-04",
"stop_at": "2025-09-24",
"budget": "250.00000",
"spend_budget": 0,
"impressions": null,
"visible_impressions": null,
"clicks": null,
"exposure_time": null,
"created_at": "2025-08-25T16:40:59.000000Z",
"updated_at": "2025-08-25T16:55:44.000000Z",
"deleted_at": null
},
"message": "Campaign retrieved successfully."
}Create a new campaign
POST https://my.smartxsp.io/api/campaigns/
Retrieves campaign details.
Query Parameters
name*
String
The campaign name
start_at*
Datetime
The start of the campaign using the format "Y-m-d" (2025-01-31)
stop_at*
Datetime
The end of the campaign using the same format that start_at
budget*
Integer
Amount of budget to serve in euros
product*
String
The main product : - smartcover - smartview - smartpulse
geo_radius
Arrays / Json
[ { lat:49.320, long:9.23, radius:20 } ]
Headers
Authorization*
String
The Bearer token you get during login process.
{
"success": true,
"data": {
"id": 7027,
"name": "Demo Campaign 2025-08-25 16:29:28",
"state": "waiting",
"account_id": 1,
"owner_account_id": 1,
"product_id": 33,
"start_at": "2025-08-25",
"stop_at": "2025-09-24",
"budget": 250,
"spend_budget": 0,
"impressions": null,
"visible_impressions": null,
"clicks": null,
"exposure_time": null,
"created_at": "2025-08-25T16:29:28.000000Z",
"updated_at": "2025-08-25T16:29:28.000000Z",
"deleted_at": null
},
"message": "Campaign created successfully."
}Get Campaign Report
GET https://my.smartxsp.io/api/campaigns{campaign_id}/report
Headers
Authorization*
String
The Bearer token you get during login process.
Path Parameters
campaign_id*
String
The numeric id of the campaign
Query Parameters
account_id
Integer
The account associated to the campaign. If not provided it will be the user account.
account_code
String
The custom account code associated to the campaign instade of the account_id
start*
Datetime
The start of the reporting
stop*
Datetime
The end of the reporting
dim_date
Boolean
Activate date dimension. If it is set to false, we will cumulate
dim_site
Boolean
Activate site (domain and id) dimension
dim_creative
Boolean
Activate creative dimension
Response
{
"success":true,
"data":{
"account_id":2216,
"campaign_id":8760,
"start":"2023-01-01",
"stop":"2023-03-01",
"report":[
{
"date":"2023-02-01",
"site_id":"6",
"site_domain":"actu.fr",
"creative_id":33876,
"impressions":3409,
"vimpressions":3209,
"clicks":24,
"exposure":459872,
"video_0":4302,
"video_25":4103,
"video_50":3570,
"video_75":3104,
"video_100":2674
},
{
"date":"2023-02-01",
"site_id":"6",
"site_domain":"actu.fr",
"creative_id":33878,
"impressions":5409,
"vimpressions":5288,
"clicks":35,
"exposure":786999,
"video_0":8944,
"video_25":8698,
"video_50":8034,
"video_75":7800,
"video_100":6535
}
]
},
"message":"Report generated successfully."
}Last updated