AudienceReport has an API that allows you to create, edit and retrieve AudienceReport resources. You can use the API to do anything you usually do through the interface, and sometimes more, depending on your setup. This is useful for a number of things, including automation, efficiency, and aggregations among others.
Here are a couple of concrete use cases:
1: You want to retrieve your latest campaigns reports, and present them in a custom pdf template
2: You want to automize campaign creation and setup every week through a scheduled job
3: You want to aggregate and present the last month of report metrics, e.g reach or frequency
4: You want to integrate AR data into your own web solution or data job
The technical requirements for using an API are minimal and require you to setup an authentication flow before you can get started. The authentication flow ensures that you have permission to perform the requested API actions on the correct data.
To quickly get started, follow these steps:
- Contact AudienceProject 'here' to get an API client issued to your AudienceReport account.
- Navigate to `https://docs.audiencereport.com/oauth-api/` and fill in the relevant fields with the client you received from step 1 and press send. This will give you a token, that identifies and allows you to begin using the API.
- Navigate to https://docs.audiencereport.com/audiencereport-api` and choose a relevant endpoint. Then, fill in the relevant fields with the token from step 2, hit send, and inspect the result.
Figure 1: Retrieving a token for authorization through your client.
Figure 2: Using the token to retrieve a list of campaigns from your account.
A successful response from the API returns data in JSON format with a relevant HTTP status code. The successful response will always contain a data field. If the request fails, an error code will be returned with a relevant message, i.e an authentication failure would look like the following:
When interfacing with the API, you can use whatever language you prefer. The following examples are written in general programming languages: