Audience Service API
Get audience information via API.
The Audience Service API allows you to directly retrieve audience information to use in marketing campaigns or other analysis.
The Audience Service endpoints require an Access Token. To generate the token, you'll need your API credentials. To generate credentials, log into your app as a Partner Administrator and navigate to the Authentication > Audience API Key section. Here, create your client_id and client_secret to be used with the Access Token endpoint.
Only one set of credentials may be active at one time. When you create credentials, be sure to copy the client_id and client_secret. The secret cannot be retrieved once you have navigated away from the page.
Parameters
The Audience Service API endpoints may require the following parameters.
| Field | Data Type | Description |
|---|---|---|
client_id | String | Credentials created in your app. |
client_secret | String | Credentials created in your app. |
token | String | Bearer token used with all Audience Service endpoints, created with the Create Token endpoint. |
id_or_slug | String | The ID or slug of the audience. Used in the path. |
institution_public_id | String | Query parameter for the public id of the institution. |
Examples
Audience data may be requested in either JSON or CSV format.
Requests
Format your requests to accept your preferred format, JSON or CSV.
Responses
Data will be returned in the requested format.