AdRoll GraphQL Reporting API Reference

Warning

The GraphQL Reporting is in beta and the schema may change. Currently only campaign-level data is stable, all other data may be unstable. If you have questions or feedback, please contact the API team.

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 by AdRoll

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

Operations

POST /reporting/api/v1/query

Execute GraphQL queries

Parameters:

Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Schema for request body: GraphQLDocument

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

Responses:

200 OK

The query was successfully performed.

Returns GraphQLResponse

Definitions

GraphQLResponse
Type:object
errors

List of errors that occurred

Type:array of GraphQLError
data

Result of your query

Type:object
ErrorLocation
Type:object
column

Column number of the source of the error

Type:integer
line

Line number of the source of the error

Type:integer
GraphQLError
Type:object
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
message

Description of the error

Required:True
Type:string
locations

Location of the error

Type:array of ErrorLocation
GraphQLDocument
Type:object
query

GraphQL query

Required:True
Type:string
variables

Query variables

Type:object
operationName

Required if multiple operations are present in the query

Type:string