{"id":402,"date":"2023-08-11T11:35:53","date_gmt":"2023-08-11T11:35:53","guid":{"rendered":"https:\/\/gripsintelligence.com\/knowledge-base\/?post_type=ht_kb&p=402"},"modified":"2023-08-31T09:20:23","modified_gmt":"2023-08-31T09:20:23","slug":"api","status":"publish","type":"ht_kb","link":"https:\/\/gripsintelligence.com\/knowledge-base\/api","title":{"rendered":"Grips API Documentation"},"content":{"rendered":"

<\/h1>\n

<\/a>Overview<\/h2>\n

This document provides an overview of the API endpoints for the Grips Intelligence data service. The API resembles GraphQL but does not strictly adhere to its specifications.<\/p>\n

<\/a>Base URL<\/h2>\n

All URLs referenced in this documentation share the following base:<\/p>\n

\n
https:\/\/app.gripsintelligence.com\/api\/data\/v1?provider=pg\r\n<\/code><\/pre>\n
<\/div>\n<\/div>\n
The base URL is followed by query parameters to define the source and provider.<\/p>\n
<\/a>Authentication<\/h2>\n
When making requests to the Grips API, include the API key in the request header. Add a header called\u00a0grips-api-key<\/code>\u00a0with the value set to your API key.<\/p>\n
<\/a>Error Messages<\/h2>\n
Currently, no standard structure is defined for error messages. Please contact\u00a0eldar.djafarov@gripsintelligence.com<\/a>\u00a0for assistance with error-related issues.<\/p>\n
<\/a>Endpoints<\/h2>\n
<\/a>1. Domain Timeseries Performance<\/h3>\n
<\/a>Endpoint<\/h4>\n
\n
https:\/\/app.gripsintelligence.com\/api\/data\/v1?provider=pg\r\n<\/code><\/pre>\n
<\/div>\n<\/div>\n
<\/a>Method<\/h4>\n
POST<\/code><\/p>\n
<\/a>Payload<\/h4>\n
When making a POST request, the payload should be in JSON format, containing two parameters:\u00a0query<\/code>\u00a0and\u00a0variables<\/code>. The\u00a0query<\/code>\u00a0parameter is a string representing the query, while the\u00a0variables<\/code>\u00a0parameter is a JSON object containing any necessary data for use within the query. Ensure both parameters are correctly formatted in the JSON payload when constructing your API request.<\/p>\n
Query<\/strong><\/p>\n
\n
    input<\/span> Date<\/span> {\r\n      gte<\/span>: String<\/span>!<\/span>\r\n      lte<\/span>: String<\/span>!<\/span>\r\n    }\r\n    input<\/span> OrArray<\/span> {\r\n      in<\/span>: [String<\/span>!<\/span>]\r\n    }\r\n    input<\/span> Filters<\/span> {\r\n      country<\/span>: String<\/span>\r\n      category<\/span>: OrArray<\/span>\r\n      domain<\/span>: OrArray<\/span>!<\/span>\r\n      date<\/span>: Date<\/span>!<\/span>\r\n    }\r\n    query<\/span> ii_transactional<\/span>($filters<\/span>: Filters<\/span>) {\r\n      timeseries<\/span>: fetch<\/span>(filters<\/span>: $filters<\/span>) {\r\n        date<\/span> (type<\/span>: Array<\/span>, sort_asc<\/span>: date<\/span>) {\r\n            transactionrevenue<\/span>: sum<\/span>(a<\/span>:transactionrevenue<\/span>)\r\n            transactions<\/span>: sum<\/span>(a<\/span>:transactions<\/span>)\r\n            sessions<\/span>: sum<\/span>(a<\/span>:sessions<\/span>)\r\n            adcost<\/span>: sum<\/span>(a<\/span>: adcost<\/span>)\r\n            aov<\/span>: divide<\/span>(a<\/span>:transactionrevenue<\/span>, by<\/span>: transactions<\/span>)\r\n            cr<\/span>: divide<\/span>(a<\/span>:transactions<\/span>, by<\/span>: sessions<\/span>)\r\n            cpc<\/span>: divide<\/span>(a<\/span>:adcost<\/span>, by<\/span>: adclicks<\/span>)     \r\n        }\r\n      }\r\n    }<\/pre>\n
<\/div>\n<\/div>\n
Variables<\/strong><\/p>\n