Contents

EligibilityQueryRequest

The request body for querying app eligibility.

Declaration

object EligibilityQueryRequest

Properties

NameTypeDescription
filters[QueryFilter]

See QueryFilter for details.

sorting[QuerySort]

See QuerySort for details.

paginationQueryPagination

See QueryPagination for details.

Discussion

The EligibilityQueryRequest object is the request body for the eligibility query endpoint. To filter, paginate, and sort the app eligibility records returned, use it.

The filters array accepts QueryFilter objects targeting filterable fields on the eligibility resource. Combine multiple filters to narrow results. For example, filter by adamId to check eligibility for a specific app.

The filters array supports the following fields:

Field

Description

adamId

The Adam ID of the app

supplyPlacement

The supply placement being checked

supplySource

The supply source being checked

countryOrRegion

The country or region evaluated

deviceClass

The device class evaluated

state

Eligibility state: ELIGIBLE or INELIGIBLE

Example

{
  "filters": [
    {
      "field": "adamId",
      "operator": "EQUALS",
      "value": 123456789
    }
  ],
  "sorting": [
    {
      "field": "countryOrRegion",
      "order": "ASC"
    }
  ],
  "pagination": {
    "offset": 0,
    "pageSize": 20
  }
}

See Also