VoidhashDocs
DocumentationAPI reference
Dashboard
Essentials
API overview
Authentication
Endpoints
Ad_accounts
Analytics
Api_keys
Session
Component_dev_sessions
Component_registry
Components
Sandbox
Events
Experiments
Feature_flags
Ingest_policy
Push_notifications
Organizations
Payment_providers
Payment_provider_products
Payment_sources
Paywall_locations
Paywalls
Perks
Persons
Products
Projects
Push_notification_configurations
Schema
Sdk
Me
Webhooks
Audit_log
Organization_members
Notices
Connected_apps
Tracking_domains
Ads
Payment_provider_history_imports
Feedback
Analytics
Event capture
Report Insights
Report Acquisition
Report Acquisition Cohorts
Report Tracking Health

Report Insights

POST
/api/v1/projects/{projectId}/analytics/reports/insights

Path Parameters

projectId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

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/projects/string/analytics/reports/insights" \  -H "Content-Type: application/json" \  -d '{    "queries": [      {        "insightId": "revenue",        "key": "string",        "timeRange": {          "preset": "today"        }      }    ]  }'
{  "results": [    {      "insightId": "revenue",      "key": "string",      "resolvedTimeRange": {        "end": "string",        "start": "string"      },      "result": {        "kind": "metric",        "sparkline": [          {            "timestamp": "string",            "value": 0          }        ],        "summary": {          "currency": "string",          "value": 0        }      }    }  ]}
{  "error": {    "type": "invalid_request",    "code": "string",    "message": "string",    "param": "string"  }}
{  "error": {    "type": "unauthenticated",    "code": "string",    "message": "string",    "param": "string"  }}
{  "error": {    "type": "permission_denied",    "code": "string",    "message": "string",    "param": "string"  }}
{  "error": {    "type": "not_found",    "code": "string",    "message": "string",    "param": "string"  }}
{  "error": {    "type": "internal",    "code": "string",    "message": "string",    "param": "string"  }}
PreviousQuery AvailableNextReport Acquisition