Skip to main content

Incremental Public API

The Incremental GraphQL API exposes one endpoint, independent of the operation being performed. Every request is made using the HTTP method of POST:

POST https://api.incremental.com/graphql

Each request carries a JSON body containing a query (and optional variables), and all responses are JSON. New to GraphQL? Start with the official guide to building queries.

curl https://api.incremental.com/graphql \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"query": "query { listCompanies(page: {limit: 5}) { items { id name } } }"}'
Escaping the query string

The string value of "query" must escape newline characters or the schema will not parse it correctly. For the POST body, use outer double quotes and escaped inner double quotes.

Where to start​

  • Authentication — get an API token or exchange OAuth client credentials for a partner token.
  • Pagination — every list query accepts a page input and returns a pageInfo object.
  • Common use cases — copy-paste query/response pairs for the most common integrations, one page per query.
  • File upload — push first-party (BYOD) data to Incremental with presigned uploads.
  • Playground — run queries against the API from your browser.

Conventions​

  • Field and argument names are camelCase; enum values are SCREAMING_SNAKE_CASE.
  • Dates are ISO-8601 strings (Date and DateTime scalars).
  • Large integers (e.g. impression counts, budgets) use the BigInt scalar.
  • List queries follow a common shape: filter, sort, and page arguments, with items and pageInfo in the response.