VoidhashDocs
DevelopersHelp centerGuidesAPI reference
Dashboard
Essentials
API overview
Authentication
Event capture
Push device API
Webhooks
Webhook delivery
Webhook events
Projects & keys
Projects
API keys
Audit log
Customers & access
Persons
Products
Perks
Sandbox
Paywalls
Paywalls
Paywall locations
Components
Component registry
Assets
Experiments & flags
Experiments
Feature flags
Analytics & events
Analytics
Analytics alerts
Events
Ingest policy
VoidQL
Tracking domains
Ads
Ads
Ad accounts
Meta measurement
Payments & stores
Payment providers
Payment provider products
Purchase history imports
Payment sources
Webhooks & notifications
Webhooks
Push notifications
Push configurations
Automations
Organization & team
Organizations
Members
Invitations
Billing
Your account
Profile
Session
Notices
Connected apps
Terms of Service
Developer tools
Schema
SDK
Retrieve the ingest policy
Turn a built-in event on or off
Block or unblock a custom event

Retrieve the ingest policy

Reads which events the project stores: every built-in ($-prefixed) event setting with its default, and the custom events it blocks.

Built-in events are stored only once enabled; custom events are stored unless blocked.

Guide: Events

GET
/api/v1/projects/{projectId}/ingest-policy

Authorization

AuthorizationBearer <token>

A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.

In: header

Path parameters

projectId*string

The project's id, proj_.... A secret key works only in the project it belongs to.

Examples

curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/ingest-policy" \  -H "Authorization: Bearer vh_sk_..."
{  "builtinEvents": [    {      "key": "$app_installed",      "name": "App installed",      "description": "First launch after a fresh install, used for install and acquisition counts.",      "eventNames": [        "$app_installed"      ],      "isEnabled": true,      "isDefaultEnabled": true,      "isOverridden": false,      "warning": null    },    {      "key": "$screen",      "name": "Screen views",      "description": "Every screen the user lands on, with the previous screen and time spent there. The highest-volume built-in event.",      "eventNames": [        "$screen"      ],      "isEnabled": true,      "isDefaultEnabled": true,      "isOverridden": false,      "warning": null    }  ],  "blockedCustomEvents": [    "debug_tap"  ]}
{  "error": {    "type": "invalid_request",    "code": "string",    "message": "string",    "param": "string"  }}
{  "error": {    "type": "unauthenticated",    "code": "invalid_api_key",    "message": "This secret key is not valid."  }}
{  "error": {    "type": "permission_denied",    "code": "permission_denied",    "message": "Insufficient permissions."  }}
{  "error": {    "type": "not_found",    "code": "project_not_found",    "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.",    "param": "projectId"  }}
{  "error": {    "type": "internal",    "code": "internal_error",    "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing."  }}

Response body

application/json

application/json

application/json

application/json

application/json

application/json

Errors

This operation adds no error codes of its own. It can fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Ingest policy

  • Turn a built-in event on or off PUT
  • Block or unblock a custom event PUT

Something wrong or missing on this page? Tell us by email or on Discord.

PreviousList eventsNextTurn a built-in event on or off

On this page

AuthorizationPath parametersExamplesResponse bodyErrorsMore in Ingest policy