We constantly publish updates to our documentation, which may not yet be available in your language. For the most current information, use the English version.

for Developers

Events endpoint

Use the Events endpoint to retrieve event slugs to use in your report service queries. The endpoint enables you to search for events using their readable names and returns useful information about each one.

Before you begin

To use this endpoint, you need an Adjust API token. Follow the instructions in the authentication guide to get your token.

Endpoint

https://dash.adjust.com/control-center/reports-service/events

GET request

Return a list of event objects.

Parameters

Parameter	Data type	Required	Description
`events__contains`	String	No	Filters events by an exact match in the event's key or a partial match in its value.

Responses

This endpoint returns the following responses:

Response	Description	Notes
200	Success	Returns report information
204	No content	Returned if the response object is empty
400	Bad request	Returned if your request is malformed or contains unsupported parameters
401	Unauthorized	Returned if your credentials are incorrect or absent
403	Forbidden	Returned if you try to access information you don't have permission to view
429	Too many requests	Returned if you exceed 50 simultaneous requests
503	Service unavailable	Returned if the server cannot be reached
504	Gateway timeout	Returned if the query takes too long to return a response

Success response

[
  {
    "id": "string",
    "name": "string",
    "short_name": "",
    "section": "",
    "formatting": "money",
    "increase_is_negative": false,
    "description": "",
    "app_token": [
      "string"
    ],
    "tokens": [
      "string"
    ]
  }
]

Parameters

Parameter	Data type	Description
`id`	String	The event slug.
`name`	String	The name of the event.
`short_name`	String	The shortened name of the event.
`section`	String	The event section. See the table below for a summary of available values.
`formatting`	String	The format in which the event's data is stored.
`increase_is_negative` Deprecated	Boolean	Whether the most recent change was a value increase.
`app_token`	Array<String>	The app token with which the event is associated.
`tokens`	Array<String>	The event's token(s).

Sections

Section	Description
`conversion`	Metrics relating to click and impression conversions.
`fraud`	Metrics relating to fraud prevention.
`cost`	Metrics relating to cost.
`revenue`	Metrics relating to app revenue.
`retention`	Metrics relating to cohort-based user retention.
`events`	Metrics relating to events.
`conversion_events`	Metrics relating to SKAdNetwork conversion events.
`installs`	Metrics relating to app installs and reinstalls.
`conversion_values`	Metrics relating to SKAdNetwork conversion values.

Example

cURL

curl --location --request GET 'https://dash.adjust.com/control-center/reports-service/events?event__contains=purchase' \
--header 'Authorization: Bearer {API_TOKEN}'

[
  {
    "id": "purchase",
    "name": "Purchase event",
    "short_name": "PUR",
    "section": "Revenue",
    "formatting": "money",
    "increase_is_negative": false,
    "description": "",
    "app_token": [
      "4zb92bmajmrd"
    ],
    "tokens": [
      "abc123"
    ]
  }
]