Skip to main content

Filters

Filter endpoints provide available filter options for querying interactions and telemetry data. These endpoints help build dynamic filter UIs by returning all possible values for filtering.

Endpoints

GET /v1/interactions/filter-options
GET /v1/interactions/telemetry-filters

Authentication

All endpoints require authentication using JWT tokens. Include the token in the Authorization header:

authorization: Bearer {token}

Interaction Filter Options

Returns available filter options for interaction queries. Provides statuses and creator emails that can be used to filter interactions.

Endpoint: GET /v1/interactions/filter-options

Request Headers:

HeaderValue
authorizationBearer {token}

Parameters: None

Example Request:

GET /v1/interactions/filter-options
authorization: Bearer {token}

Response:

{
"data": {
"statuses": [
"RUNNING",
"STOPPED",
"DELETED"
],
"createdBy": [
"user1@dream11.com",
"user2@dream11.com",
"user3@dream11.com"
]
}
}

Response Fields:

FieldTypeDescription
data.statusesstring[]Available interaction status values
data.createdBystring[]Email addresses of users who created interactions

Telemetry Filter Options

Returns available telemetry filter values for data queries. Provides app versions, device models, platforms, OS versions, network providers, and geographic states for filtering telemetry data.

Endpoint: GET /v1/interactions/telemetry-filters

Request Headers:

HeaderValue
authorizationBearer {token}

Parameters: None

Example Request:

GET /v1/interactions/telemetry-filters
authorization: Bearer {token}

Response:

{
"data": {
"appVersionCodes": [
"1.0.0",
"1.1.0",
"1.2.0",
"2.0.0"
],
"deviceModels": [
"iPhone 14",
"iPhone 14 Pro",
"OnePlus 11",
"Samsung Galaxy S23"
],
"networkProviders": [
"Airtel",
"Jio",
"Vodafone"
],
"platforms": [
"Android",
"iOS"
],
"osVersions": [
"Android 13",
"Android 14",
"iOS 16.5",
"iOS 17.0"
],
"states": [
"IN-DL",
"IN-KA",
"IN-MH",
"IN-TN"
]
}
}

Response Fields:

FieldTypeDescription
data.appVersionCodesstring[]Available app version codes
data.deviceModelsstring[]Available device model names
data.networkProvidersstring[]Available network carrier names
data.platformsstring[]Available platforms (Android, iOS)
data.osVersionsstring[]Available operating system versions
data.statesstring[]Available geographic state codes