Sign in
latestOpenAPI 3.0.02026-08-10239286205.0 KB

e86f45ae5f7c

meter-ads

List active meter ads by partner ID

Returns an array of active meter ads for a given partner ID. If no partner ID is provided, the default partner ID is used. Active means that the status is "published", the start date is in the past, and the end date is in the future.

get/v1/meter-ads/active

Query parameters

partnerIdstring

Partner ID to filter active meter ads. Falls back to "default" if not provided

urlstring

Response

An array of MeterAd entities

idstring required
partnerIdstring required
startTimenumber required

Unix timestamp in milliseconds

endTimenumber required

Unix timestamp in milliseconds

questionTextstring required
marketingTextstring
status'DRAFT' | 'PUBLISHED' | 'CANCELLED' required
createdAtstring date-time required

Unix Timestamp in milliseconds of when the record was created

updatedAtstring date-time required

Unix Timestamp in milliseconds of when the record was last updated

urlstring required