Get campaigns
/brand-api/resource/campaigns
Retrieves a list of campaigns for a brand.
You'll see the previous campaigns and the render status of each campaign.
You can download the campaign via the download_url
once it's ready .
Request
Query Params
brand_uuid
string
required
You can get brand_uuid
from the get brands or get layouts endpoint.
Example:
{{brand_uuid}}
page
integer
required
> 0
Example:
1
page_size
integer
required
> 0
Example:
10
Request samples
Responses
List campaigns(200)
Error(200)
Bad Request(400)
HTTP Code: 200
Content Type : JSON
Data Schema
campaigns
array [object {9}]
required
uuid
string
required
Example:
321c7a54-7412-4677-af25-1844b353eb89
name
string
required
Example:
campaign name
created_at
number
required
Example:
1234567890
created_by
string
required
This is usually the account associated with the API key.
Example:
user name
layout_uuid
string
required
Example:
5ddc752f-b0ff-4962-bde7-01e8c15e1c53
layout_name
string
required
Example:
layout name
render_state
string
required
State of the rendering process.
Example:
render_success
preview_url
string <uri> | null
required
A thumbnail link to the rendered campaign.
download_url
string <uri>
required
The download link of the campaign.
meta
object
required
page
number
required
Example:
1
page_size
number
required
Example:
10
total_count
number
required
Example:
100
total_pages
number
required
Example:
10
Example
{
"campaigns": [
{
"uuid": "321c7a54-7412-4677-af25-1844b353eb89",
"name": "campaign name",
"created_at": 1234567890,
"created_by": "user name",
"layout_uuid": "5ddc752f-b0ff-4962-bde7-01e8c15e1c53",
"layout_name": "layout name",
"render_state": "render_success",
"preview_url": "http://example.com",
"download_url": "http://example.com"
}
],
"meta": {
"page": 1,
"page_size": 10,
"total_count": 100,
"total_pages": 10
}
}
Modified at 14 hours ago