Sign in
latestOpenAPI 3.0.02026-08-10239286205.0 KB

e86f45ae5f7c

meter-ads

List meter ads, filtered by search terms and sort options.

get/v1/admin/meter-ads

Query parameters

partnerIdstring

Partner ID to filter by

questionTextstring

Will do a partial case-insensitive match on question text

marketingTextstring

Will do a partial case-insensitive match on marketing text

status'DRAFT' | 'PUBLISHED' | 'CANCELLED'
valuenumber required

Unix timestamp in milliseconds

operator'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'neq' required

Comparison operator to apply

Provide a value and comparison operator to filter by start time Unix timestamp in milliseconds

{
  "value": 1643673600000,
  "operator": "gte"
}
valuenumber required

Unix timestamp in milliseconds

operator'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'neq' required

Comparison operator to apply

Provide a value and comparison operator to filter by end time Unix timestamp in milliseconds

{
  "value": 1643673600000,
  "operator": "gte"
}
status'ASC' | 'DESC'

Sort direction for status

partnerId'ASC' | 'DESC'

Sort direction for partnerId

startTime'ASC' | 'DESC'

Sort direction for startTime

endTime'ASC' | 'DESC'

Sort direction for endTime

questionText'ASC' | 'DESC'

Sort direction for questionText

marketingText'ASC' | 'DESC'

Sort direction for marketingText

Dictionary of property names to sort direction (ASC or DESC)

pagenumber

Page number (1-based); the default is 1

pageSizenumber

Number of items per page; the default is 20

Response

A paginated list of MeterAd entities

totalnumber required
pagenumber required
pageSizenumber required
pageCountnumber required