Get one page of posts.

get https://api.creativex.com/api/v3/reports/{id}/posts

Responses

Response body

object

report

array of objects

report

object

string

Unique Report ID you inputted.

status

string

Status of the Report. The status will either be “DONE” or “IN_PROGRESS”. Once the report is "DONE", you will be able to view your creative data and query subsequent pages.

response_metadata

array of objects | null

response_metadata

object

next_page

string | null

Identifier used to get the next page available of data. You’ll need to keep making requests to get all the data for all pages (this will happen when next_page is “null”).

data

array of objects | null

data

object

creativex_asset_id

integer

CreativeX asset ID

creativex_post_id

integer

CreativeX post ID

status

string

This represents whether the post is in In-Flight or Pre-Flight

name

string

Name of the post

string

Email of the user who uploaded the asset into Pre-Flight

brand

string

Brand for the post

market

string

Market for the post

channel

string

Platform for the post

company

string

Partner associated with the post

asset_type

string

This represents whether the post is a video or image

spend

float

Media spend associated with the post

date_captured

date

The date_captured field is the date we first pull in the post into CreativeX. If the date_captured date is older than the month you are querying, it's possible the post was pulled in before that month.

creative_link

string

CreativeX link where the post is stored

post_link

string

Platform link where the post is activated

ad_id

string

Ad ID for the post

cta

string

Call to action associated with the post in In-Flight

ad_format

string

content_type

string

aspect_ratio

string

Aspect ratio of the post

dimensions

string

Dimensions of the post

width

integer

Width of the post

height

integer

Height of the post

video_length

float

Video length of the post

ad_account_name

string

Name of the Ad Account associated with the post in In-Flight

ad_account_id

string

ID of the Ad Account associated with the post in In-Flight

campaign_name

string

Campaign name associated with the post in In-Flight

campaign_id

string

Campaign ID associated with the post in In-Flight

campaign_objective

string

Campaign objective associated with the post in In-Flight

clicks

integer

Media performance metrics

impressions

integer

Media performance metrics

ctr

float

Media performance metrics

cpm

float

Media performance metrics

cpc

float

Media performance metrics

video_3_sec_views

integer

Media performance metrics

video_15_sec_views

integer

Media performance metrics

video_30_sec_views

integer

Media performance metrics

video_25_views

string

Media performance metrics

video_50_views

string

Media performance metrics

video_75_views

string

Media performance metrics

video_100_views

string

Media performance metrics

estimated_ad_recall_rate

string

Media performance metrics

compliant

boolean

This is relevant for Regulatory Compliance and represents whether the post was compliant or non compliant

creative_quality_score

float

This is relevant for Creative Quality and represents the proportion of creatives that have met a client’s best practice guidelines

creative_quality_tier

string

Clients can determine the minimum threshold for their creative quality (i.e. Excellent, On Track, etc.)

regulations

array of objects

regulations

object

regulation_id

string

This is relevant for Regulatory Compliance and represents the regulation ID associated with the regulation configured

regulation_name

string

This is relevant for Regulatory Compliance and represents the regulation name

value

float

This represents whether the regulation is present or not (1 if present, 0 otherwise)

brand_cues

array of objects

brand_cues

object

brand_cue_id

string

This is relevant for Brand Consistency and represents the brand cue ID associated with the brand cue configured

brand_cue_name

string

This is relevant for Brand Consistency and represents the brand cue name

value

float

This represents whether the regulation is present or not (1 if present, 0 otherwise)

guidelines

array of objects

guidelines

object

guideline_id

string

This is relevant for Creative Quality and represents the guideline ID associated with the guideline configured

guideline_name

string

This is relevant for Creative Quality and represents the guideline name

value

float

This represents whether the regulation is present or not (1 if present, 0 otherwise)

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.creativex.com/api/v3/reports/id/posts \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200One page of reporting data

400Invalid request

404Invalid Report or Page ID