Collective Audience API

Collective Audience™ has opened an API that allows external application to retrieve some information.

Usage

Allowed method

Currently, the only action that is allowed is the READ action through HTTP GET requests that return JSON responses. Initially, the API endpoints just give access to statistics.

The base url to access the API is https://data.collectiveaudience.co/api

GET https://data.collectiveaudience.co/api

RESPONSE 200 OK

Security

Access to Collective Audience™ API is protected by a personal API KEY that must be passed in every request as a query param ?api_key={YOUR_API_KEY}. The access to and management of API keys depend on whether you want to access stats for a Managed account or a Self one.

Managed account

If you are a Collective Audience™ customer but not handling your own account / creatives / campaigns, you can contact our team and ask for an API key in order to integrate it in your workflows.

Self account

If you are managing your own account / creatives / campaigns

In your Collective Audience™ Account, you will be able to find a section in the settings to manage your API keys

Learn how to manage your API keys in the next page (→ api-generate-key)

Entities

To perform its mission, Collective Audience™ is managing some object/entities such as Accounts, Campaigns, Creatives, ...

A call to Collective Audience™ open API must include the name of the entities after the base url.

List items

GET https://data.collectiveaudience.co/api/{entityName}?api_key={yourToken}

RESPONSE LIST OF RESOURCES OF THAT {entityName} TYPE

GET one item

GET https://data.collectiveaudience.co/api/{entityName}/{id}?api_key={yourToken}

RESPONSE ONE ITEM IDENTIFIED BY {id}

Progress

Already developed enpoints cover :

Campaigns

General stats

Based on these entities, Collective Audience™ is providing a route per entity to get statistics that are available in real-time. To use it, you just have to add /stats/ between /api/ and {entityName}

List items

GET https://data.collectiveaudience.co/api/stats/{entityName}?api_key={yourToken}

RESPONSE LIST OF RESOURCES OF THAT {entityName} TYPE

GET one item

GET https://data.collectiveaudience.co/api/stats/{entityName}/{id}?api_key={yourToken}

RESPONSE ONE ITEM IDENTIFIED BY {id}