These docs are for v1.0. Click to read the latest docs for v2.0.
added

Multi-aggregate charts & new Topics endpoint introduced

Updated Data Retrievalwith the section dedicated to the description of the new Topics endpoint here: Topics (New)

added

Data Upload API: new fields reachEstimate and rawMetadata

Updated Uploading Documents with the definition of the new fields: reachEstimateand rawMetadata

added

Mentions API: Tiktok field definitions added, mentions retrieval payload examples updated with both Bluesky and Tiktok

With Tiktok integrated as a new content source more information here, three new Tiktok specific fields are returned in Mentions API payloads. Therefore, we updated the Mention Field Definition with these parameters.
Payload examples in Retrieving Mentions has been updated with Bluesky and Tiktok fields.

added

Mentions API: Bluesky field definitions added

With Bluesky integrated as a new content source more information here, multiple Bluesky specific fields are returned in Mentions API payloads. Therefore, we updated the Mention Field Definition with these parameters.
Note: payload examples have not been updated yet.

added

Mentions API: dailyVisitors definition added, payload examples updated

With our new Net Reach metric launched more information here, the dailyVisitors parameter is also returned in Mentions API payloads. Therefore, we updated the Mention Field Definition with this parameter, while also amended the payload examples on the Retrieving Mentions and Retrieving Filtered Mentions pages.

improved

X Insights payload enhanced

We have enhanced the X (Twitter) Insights endpoint payload with sentiment analysis.

improved

Mentions fields definition improved

We heavily updated the definition of the mentions fields, to better reflect reality: Mention Field Definition

removed

Query API: ´createdByWizard´ field removed

The response field createdByWizard has been removed from the response payload example. This field was an internal field used by our BCR frontend to detect queries created through the Wizard, which is feature recently decommissioned, making this field obsolete.

deprecated

HTTP & TLS 1.1 Support

As of May 14, 2020 the Consumer Research API will no longer support using HTTP and TLS 1.1.

deprecated

Sorting mentions by orderby=id

The usage of the orderby=id parameter has been deprecated as of August 15, 2019. If you are still using this parameter we recommend you upgrade to alternative ways of sorting your data as soon as you can.
Depending on your use case, we recommend the following alternatives: