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 Acquisition Cohorts

PreviousReport AcquisitionNextReport Tracking Health
POST
/api/v1/projects/{projectId}/analytics/reports/acquisition-cohorts

Path Parameters

projectId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

adsetId?|null
campaignId?|null
currency?string|null
environment?|null
from*string

A calendar date, YYYY-MM-DD, in the report time zone.

groupBy*string

Value in

  • "surface"
  • "network"
  • "campaign"
  • "adset"
network?|null
timezone?|null
to*string

A calendar date, YYYY-MM-DD, in the report time zone.

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/acquisition-cohorts" \  -H "Content-Type: application/json" \  -d '{    "from": "string",    "groupBy": "surface",    "to": "string"  }'
{  "projectId": "string",  "groupBy": "surface",  "currency": "string",  "timezone": "string",  "environment": "production",  "from": "string",  "to": "string",  "start": "string",  "end": "string",  "asOf": "string",  "days": [    -9007199254740991  ],  "groups": [    {      "network": "string",      "campaignId": "string",      "campaignName": "string",      "adsetId": "string",      "adsetName": "string",      "adId": "string",      "adName": "string",      "surface": "web",      "cohorts": [        {          "week": "string",          "from": "string",          "to": "string",          "people": -9007199254740991,          "cells": [            {              "day": -9007199254740991,              "people": -9007199254740991,              "payingPeople": -9007199254740991,              "grossRevenue": -9007199254740991,              "refunds": -9007199254740991,              "netRevenue": -9007199254740991,              "maturity": "complete"            }          ]        }      ]    }  ],  "total": [    {      "week": "string",      "from": "string",      "to": "string",      "people": -9007199254740991,      "cells": [        {          "day": -9007199254740991,          "people": -9007199254740991,          "payingPeople": -9007199254740991,          "grossRevenue": -9007199254740991,          "refunds": -9007199254740991,          "netRevenue": -9007199254740991,          "maturity": "complete"        }      ]    }  ]}
{  "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"  }}