Report Acquisition
Path Parameters
projectId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
adId?|null
adsetId?|null
campaignId?|null
currency?string|null
environment?|null
from*string
A calendar date, YYYY-MM-DD, in the report time zone.
hasDailyRows?boolean|null
hasSurfaceBreakdown?boolean|null
keyConversion?|null
level*string
Value in
- "network"
- "campaign"
- "adset"
- "ad"
- "surface"
network?|null
revenueWindow?||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" \ -H "Content-Type: application/json" \ -d '{ "from": "string", "level": "network", "to": "string" }'{ "projectId": "string", "level": "network", "network": "string", "campaignId": "string", "adsetId": "string", "adId": "string", "currency": "string", "timezone": "string", "environment": "production", "keyConversion": "signup", "from": "string", "to": "string", "start": "string", "end": "string", "revenueWindow": { "kind": "all" }, "revenueEnd": "string", "groups": [ { "peopleAcquired": -9007199254740991, "signups": -9007199254740991, "visits": -9007199254740991, "appInstalls": -9007199254740991, "trialStarters": -9007199254740991, "trialConversions": -9007199254740991, "payingPeople": -9007199254740991, "crossSurfacePayers": -9007199254740991, "keyConversions": -9007199254740991, "signupToPayerRate": 0, "returningPeople": -9007199254740991, "grossRevenue": -9007199254740991, "refunds": -9007199254740991, "netRevenue": -9007199254740991, "network": "string", "campaignId": "string", "campaignName": "string", "adsetId": "string", "adsetName": "string", "adId": "string", "adName": "string", "surface": "web", "days": [ { "peopleAcquired": -9007199254740991, "signups": -9007199254740991, "visits": -9007199254740991, "appInstalls": -9007199254740991, "trialStarters": -9007199254740991, "trialConversions": -9007199254740991, "payingPeople": -9007199254740991, "crossSurfacePayers": -9007199254740991, "keyConversions": -9007199254740991, "signupToPayerRate": 0, "returningPeople": -9007199254740991, "grossRevenue": -9007199254740991, "refunds": -9007199254740991, "netRevenue": -9007199254740991, "date": "string" } ], "signupSurfaces": [ { "surface": "web", "peopleAcquired": -9007199254740991, "appInstalls": -9007199254740991, "trialStarters": -9007199254740991, "payingPeople": -9007199254740991, "grossRevenue": -9007199254740991, "refunds": -9007199254740991, "netRevenue": -9007199254740991 } ], "paymentSurfaces": [ { "surface": "web", "payingPeople": -9007199254740991, "grossRevenue": -9007199254740991, "refunds": -9007199254740991, "netRevenue": -9007199254740991 } ] } ], "unattributed": { "peopleAcquired": -9007199254740991, "signups": -9007199254740991, "visits": -9007199254740991, "appInstalls": -9007199254740991, "trialStarters": -9007199254740991, "trialConversions": -9007199254740991, "payingPeople": -9007199254740991, "crossSurfacePayers": -9007199254740991, "keyConversions": -9007199254740991, "signupToPayerRate": 0, "returningPeople": -9007199254740991, "grossRevenue": -9007199254740991, "refunds": -9007199254740991, "netRevenue": -9007199254740991, "days": [ { "peopleAcquired": -9007199254740991, "signups": -9007199254740991, "visits": -9007199254740991, "appInstalls": -9007199254740991, "trialStarters": -9007199254740991, "trialConversions": -9007199254740991, "payingPeople": -9007199254740991, "crossSurfacePayers": -9007199254740991, "keyConversions": -9007199254740991, "signupToPayerRate": 0, "returningPeople": -9007199254740991, "grossRevenue": -9007199254740991, "refunds": -9007199254740991, "netRevenue": -9007199254740991, "date": "string" } ], "signupSurfaces": [ { "surface": "web", "peopleAcquired": -9007199254740991, "appInstalls": -9007199254740991, "trialStarters": -9007199254740991, "payingPeople": -9007199254740991, "grossRevenue": -9007199254740991, "refunds": -9007199254740991, "netRevenue": -9007199254740991 } ], "paymentSurfaces": [ { "surface": "web", "payingPeople": -9007199254740991, "grossRevenue": -9007199254740991, "refunds": -9007199254740991, "netRevenue": -9007199254740991 } ] }, "totals": { "peopleAcquired": -9007199254740991, "signups": -9007199254740991, "visits": -9007199254740991, "appInstalls": -9007199254740991, "trialStarters": -9007199254740991, "trialConversions": -9007199254740991, "payingPeople": -9007199254740991, "crossSurfacePayers": -9007199254740991, "keyConversions": -9007199254740991, "signupToPayerRate": 0, "returningPeople": -9007199254740991, "grossRevenue": -9007199254740991, "refunds": -9007199254740991, "netRevenue": -9007199254740991 }, "funnel": [ { "step": "visits", "count": -9007199254740991, "surfaces": [ { "surface": "web", "count": -9007199254740991 } ] } ], "convertedOn": { "surfaces": [ { "surface": "web", "payingPeople": -9007199254740991, "grossRevenue": -9007199254740991, "refunds": -9007199254740991, "netRevenue": -9007199254740991 } ], "crossSurfacePayers": -9007199254740991, "journeys": [ { "touch": "web", "signup": "web", "payment": "web", "payingPeople": -9007199254740991 } ] }, "coverage": { "attributedRevenue": -9007199254740991, "totalRevenue": -9007199254740991, "share": 0, "netRevenue": -9007199254740991, "classes": [ { "class": "paid", "network": "string", "netRevenue": -9007199254740991, "share": 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" }}