Version History

v4.0.0

released 08-012-2025

New in v4

1. We now support partner and channel based data restrictions on access tokens.
   1. Previously, in order to give a partner access to your reporting data via the reporting API, you would need to share one of your access tokens with them. This would let them see all of your data through the reporting API, even data associated with other partners.
   2. Now, we have the option to create tokens which will only show data for specific partners or specific channels.
   3. Note that any tokens which we have already created will be unrestricted by default.
2. We are making additional platform metrics available in the reporting API.
   1. The new fields are all_conversions, conversions, dpvr, engagement_rate, engagements, new_to_brand_purchase_rate, new_to_brand_roas, purchase_count, purchase_rate, roas
3. We are making third party data available through the reporting API.
   1. If you have connected any partners through our Creative Data Management (CDM) application, you can now see any data they have added for your posts in the third_party_data report field.
   2. This includes the scores which you can see on the creatives page, as well as supplementary data and metrics which are not visible.
4. When requesting a report, you now have the ability to specify which report fields we include in it.
   1. Previously, when you requested a report, you had no control over the fields we calculated for it.
   2. Now, with the optional fields parameter, you can passing in a comma-separated list of field names. If you pass in field names, we will only include those fields in your report.
   3. If you do not specify any report fields to be calculated, we will default to calculating all fields.

Changes from v3

1. We are moving from parameter-based authorization to header-based authorization. Instead of passing your access token in the access_token parameter, you will need to include it in your header (e.g. { "Authorization" => "Bearer 123myaccesstoken321 }).
2. We are renaming our reporting api endpoints:
   1. /reports becomes /reports/posts
   2. /reports/{id}/posts becomes /reports/posts/{id}
   3. reports/dimensions becomes /reports/posts/dimensions
3. The optional filter parameters for /reports/posts are now all plural instead of singular (e.g. instead of passing brand, you will need to pass brands).
4. We are now omitting inapplicable fields from our reports.
   1. Not every field can meaningfully be calculated for every post. For example, inflight posts are not uploaded by a specific user, and therefore do not have an email associated with them. In v3, we would have returned a value of "N/A" or null for any field which could not be calculated due to being inapplicable to the post.
   2. In v4, we will instead omit any inapplicable fields. We will return null to indicate when a field is applicable but could not be calculated due to a lack of data.
   3. This will not affect the data you get back in a report. Any fields omitted from a report would not have held any meaningful data had they been included.

v3.1.0

released 09-10-2024

We have added support for Ad Format and Content Type fields. Not only are these now available as parameters for filtering reports, but they have also been added to the report schema itself. Please check endpoint documentation for details.

v3.0.0

released 12-01-2022

We introduced asynchronous pagination for our Reporting API data with a limit of 1,000 posts per page. This will provide a smoother experience for our clients, and reduce any potential timeout errors.

You'll need to make several calls in order to get CreativeX data:

• Generate a report with the same filter criteria you specify today.
• Fetch associated CreativeX data for the report once ready.
• We'll return the first page of data (which would include at most 1,000 posts) and details on how to request the next page (if there are more pages to call on).
• Continue requesting page by page until all pages have been read.

We have not made any changes to the dimensions endpoint except renaming it.

v2.0.0

released 10-13-2021

Certain field names and data types have been updated for clarity and better data handling. We've also added a new field for currency (ex: USD) if there's spend present. Lastly, we've started using NULL for irrelevant/empty values.

Previous Version	New Version
ctr : string	ctr : float
cpc : string	cpc : float
cpm : string	cpm : float
creative_quality_score : string	creative_quality_score : float
total_spend_usd	spend currency if spend is present
N/A for irrelevant/empty values	null for irrelevant/empty values
rule_id	guideline_id, brand_cue_id, regulation_id
rule_name	guideline_name, brand_cue_name, regulation_name

v1.0.0

released 2021

CreativeX launched our first Reporting API integration to allow clients to programmatically connect CreativeX data to their internal data lake. This included Creative Quality scores, media post data as well as platform performance metrics.