The Acoustic Connect API service is available to all existing clients. You only need an API key to authenticate your requests.
Getting access to the service
Here is where to get an API key for your requests.
- Log in to Connect under an administrator account.
- Go to Administration > General settings > API keys.
- Click Generate API key.
- Enter the name of the person or application that will be using the key and provide a description.
- Copy your key to a secure location (for security purposes, it will not be visible in Connect after you close the dialogue).
Making requests
All requests to the Acoustic Connect API are structured in the same way.
1: API endpoint
https://{host}, where {host} is the API server assigned to your organization. Below is the list of all available API servers.
| Region code | API server |
|---|---|
| us-east-1 | connect-gql-us-1.goacoustic.com |
| ap-southeast-2 | connect-gql-ap-3.goacoustic.com |
| eu-central-1 | connect-gql-eu-1.goacoustic.com |
2: Headers
| Header name | Description | Required? | Values |
|---|---|---|---|
x-api-key | An access key associated with a user account. See theGetting access to the service section above for instructions. | Required | String |
Content-Type | The original media type of the resource | Required | application/json |
3: Body
The body contains a query or a mutation.
Sample request
Here is a sample request for your reference.
curl --location 'https://connect-gql-us-1.goacoustic.com' \
--header 'x-api-key: 123445678890000000XXXX0091' \
--header 'Content-Type: application/json' \
--data '{"query":"query {\n dataSets {\n nodes {\n dataSetId\n consentGroups {\n id\n name\n }\n }\n }\n}","variables":{}}'