VoidhashDocs

Query Insights

POST
/api/v1/analytics/queries/insights

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

projectId?string|null
queries*array<>
Items1 <= items <= 20

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/analytics/queries/insights" \  -H "Content-Type: application/json" \  -d '{    "queries": [      {        "insightId": "builtin/revenue",        "key": "string",        "timeRange": {          "preset": "today"        }      }    ]  }'
{  "results": [    {      "insightId": "builtin/revenue",      "key": "string",      "resolvedTimeRange": {        "end": "string",        "start": "string"      },      "result": {        "kind": "metric",        "sparkline": [          {            "timestamp": "string",            "value": 0          }        ],        "summary": {          "currency": "string",          "value": 0        }      }    }  ]}
{  "_tag": "Api/InvalidMetricError",  "message": "string"}
{  "_tag": "Api/AuthenticationError",  "cause": "string",  "message": "string"}
{  "_tag": "Api/ActionForbiddenError",  "message": "string"}
{  "_tag": "Api/UnknownInsightError",  "insightId": "string",  "message": "string"}
{  "_tag": "Api/AnalyticsServiceError",  "cause": "string"}
PreviousAuthenticationNextCreate Secret Key