Getting Started

How to get up and running with the Marketplacer Analytics API

  less than a minute  

Getting Started

You will need to be participating in the early access program in order to use the Analytics API. Please speak to your Marketplacer Technical Account Manager for more information on joining.


To access the Analytics API your will need:
  • The API Endpoint
  • A Bearer Token
  • A suitable GraphQL query to call the API

Once you have this information, you can then configure the API client of your choice, (Insomnia, Postman, Altair, Curl etc) as follows:

  • Create a HTTP POST Request with the API Endpoint as the target URL
  • Add an Authorization header of type Bearer, and supply the token.
  • Add the GraphQL Query to the request body

Example

An Example Curl request is shown below:

curl -XPOST 
-H 'authorization: Bearer <your_bearer_token>' 
-H "Content-type: application/json" 
-d '{"query":"query MyQuery {\n\tinvoiceSummary(where: { invoicePaidAt: { gt: \"2020-10-10\" } }) {\n\t\tinvoiceCommissionSum\n\t}\n}\n"}' 
'https://yousuppliedendpoint\graphql'