Magidoc

Noticeable GraphQL API

The Noticeable API is a GraphQL API: every request is a POST of a JSON body to a single endpoint.

    
  

Authentication

#

Requests carry an access token of your organization in the Authorization header, with the Apikey scheme:

    
  

Access tokens are created in the dashboard, in your organization's API settings. Keep them secret: a token acts on your organization's projects.

A first request

#

    
  

Conventions

#

  • Dates and times are ISO-8601 strings in UTC (DateTime); analytics periods are UTC days.
  • Lists are paginated as connections: ask for first items, then pass pageInfo.endCursor as after.
  • Deprecated fields still answer, and name the field to use instead.

Try it

#

The playground runs queries against the API with your access token.