Filters data endpoint

The Filters Data endpoint enables you to retrieve a list of filter options. You can use these options to filter calls to other endpoints in the Report Service API suite.

A full list of metrics is available in the 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

1
GET https://automate.adjust.com/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.
`[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.

Required filters

Filter	Description
`ad_revenue_sources`	Returns a list of ad revenue sources.
`ad_spend_mode`	Returns a list of ad spend modes. Examples: attribution, network, mixed.
`apps`	Returns a list of your apps.
`apps_network`	Returns a list of your apps and their associated store IDs.
`attributes`	Returns a list of attributes.
`attribution_types`	Returns a list of attribution types. Examples: click, impression, engaged_ad.
`attribution_source`	Returns a list of attribution sources.
`attribution_status`	Returns a list of attribution statuses.
`channels`	Returns a list of channels.
`cohort_maturity`	Returns a list of cohort maturity options. Example: immature
`countries`	Returns a list of countries.
`currencies`	Returns a list of currencies.
`dimensions`	Returns a list of dimensions.
`full_cohort_periods`	Returns a list of time periods related to cohorts.
`iap_revenue_mode`	Returns a list of ad revenue modes.
`monetization_partners`	Returns a list of ad revenue moentization partners.
`networks`	Returns a list of networks.
`os_names`	Returns a list of operating system names.
`partners`	Returns a list of partners.
`platform`	Returns a list of platforms. Example: mobile_app
`period_over_period`	Returns a list of time periods used for data comparison.
`sdk_signature_version`	Returns a list of SDK signature versions.
`skad_time_adjustment`	Returns a list of valid SKAdNetwork activity windows.
`store_type`	Returns a list of app stores.
`subscription_revenue_mode`	Returns a list of ad revenue modes.
`utc_offset`	The offset (in hours) from UTC. Defaults to 0 (UTC).

Responses

This endpoint returns the following responses:

Response	Message	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 the rate limit
`503`	`Service unavailable`	Returned if the server can’t be reached
`504`	`Gateway timeout`	Returned if the query takes too long to return a response

Success response

1
{
2
   "required_filters_1": [
3
      {
4
         "id": "string",
5
         "name": "string",
6
         "short_name": "string",
7
         "section": "string",
8
         "formatting": "string",
9
         "description": "string"
10
      }
11
   ],
12
   "required_filters_2": [
13
      {
14
         "id": "string",
15
         "name": "string",
16
         "short_name": "string",
17
         "section": "string",
18
         "formatting": "string",
19
         "description": "string"
20
      },
21
      {
22
         "id": "string",
23
         "name": "string",
24
         "short_name": "string",
25
         "section": "string",
26
         "formatting": "string",
27
         "description": "string"
28
      }
29
   ]
30
}

Parameters

Parameter	Data type	Description
`id`	`String`	The ID of the filter item. Use this to filter your API calls.
`name`	`String`	The readable name of the filter item.
`short_name`	`String`	The shortened name of the filter item.
`section`	`String`	The section the filter item is associated with.
`formatting`	`String`	The data format of the filter item. Example: `money`, `decimal`, `string`.
`description`	`String`	The description of the filter item.

Example

curl --location --request GET 'https://automate.adjust.com/reports-service/filters_data?required_filters=dimension,ad_spend_modes&dimensions__contains=source' \
--header 'Authorization: Bearer {API_TOKEN}'

{
  "ad_spend_mode": [
   {
      "id": "adjust",
      "name": "Attribution",
      "short_name": "",
      "section": "",
      "formatting": null,
      "description": "",
    },
    {
      "id": "mixed",
      "name": "Mixed",
      "short_name": "",
      "section": "",
      "formatting": null,
      "description": "",
    },
    {
      "id": "network",
      "name": "Network",
      "short_name": "",
      "section": "",
      "formatting": null,
      "description": "",
    }
  ],
  "dimensions": [
    {
      "id": "source_id_network",
      "name": "Source ID",
      "short_name": "",
      "section": "",
      "formatting": null,
      "description": "The ID of the app where the ad was placed.",
    },
    {
      "id": "source_network",
      "name": "Source name",
      "short_name": "",
      "section": "",
      "formatting": null,
      "description": "The name of the app where the ad was placed.",
    }
  ]
}