Help Center
|
Filters data endpoint
The Filters Data endpoint enables you to retrieve a list of valid metrics. You can use these metrics to filter calls to other endpoints in the Report Service API suite.
A full list of metrics is available in our Datascape metrics glossary.
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/filters_data
GET request
Return a list of filter items. Use the id
field of the returned objects to filter other API calls.
Parameters
Parameter | Data type | In | Description |
---|---|---|---|
required_filters * | String | Query | A comma separated list of filters. See the Required filters table below for a list of values. |
section | Enum<String> | Query | The section you want to filter items by. See the Section table below for a list of values. |
[required_filters]__contains | String | Query | Enter a search term to look for a full or partial match in the object's id and name fields. |
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
{
"required_filters_1": [
{
"id": "string",
"name": "string",
"short_name": "string",
"section": "string",
"formatting": "string"
}
],
"required_filters_2": [
{
"id": "string",
"name": "string",
"short_name": "string",
"section": "string",
"formatting": "string"
},
{
"id": "string",
"name": "string",
"short_name": "string",
"section": "string",
"formatting": "string"
}
]
}
Example
{
"overview_metrics": [
{
"id": "ecpi_all",
"name": "eCPI (All Installs)",
"short_name": "eCPI (All)",
"section": "Cost",
"formatting": "money"
},
{
"id": "ecpi",
"name": "eCPI (Paid Installs)",
"short_name": "eCPI (Paid)",
"section": "Cost",
"formatting": "money"
}
],
"cost_metrics": [
{
"id": "network_cost",
"name": "Ad Spend (Network)",
"short_name": "",
"section": "Cost",
"formatting": "decimal"
},
{
"id": "network_cost_diff",
"name": "Ad Spend Diff (Network)",
"short_name": "",
"section": "Cost",
"formatting": "decimal"
}
]
}