GraphQL Reporting API Reference¶

Note

If you use the APIs provided here, you are subject to the API Terms of Use

Note

We’ve introduced API keys, please read Migrating to API Keys

Description¶

AdRoll GraphQL Reporting API 1

Access your data with the AdRoll GraphQL Reporting API. See the GraphQL Schema documentation in https://app.adroll.com/reporting/graphiql

External documentation

AdRoll API Documentation

List of Operations¶

POST /reporting/api/v1/query

Operations¶

POST /reporting/api/v1/query¶

Execute GraphQL queries

Parameters:

Query Parameters¶
Name	Required	Type	Description
`apikey`	False	string	Required if using Personal Access Tokens (PAT). The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body: GraphQLDocument

{
  "operationName": "string",
  "query": "string",
  "variables": {}
}

Responses:

200

The query was successfully performed.

Returns GraphQLResponse

Definitions¶

GraphQLDocument¶

Type: object

query

GraphQL query

Required: True
Type: string

operationName

Required if multiple operations are present in the query

Type: string

variables

Query variables

Type: object

GraphQLResponse¶

Type: object

data

Result of your query

Type: object

errors

List of errors that occurred

Type: array of GraphQLError

GraphQLError¶

Type: object

message

Description of the error

Required: True
Type: string

locations

Location of the error

Type: array of ErrorLocation

path

List of path segments starting at the root of the response and ending with the field associated with the error

Type: array of items

ErrorLocation¶

Type: object

line

Line number of the source of the error

Type: integer

column

Column number of the source of the error

Type: integer