AirtimeTransaction

Get historical airtime transaction statistics

Retrieves statistics about airtime transactions sent via Telerivet. This endpoint returns historical data for successful transactions that is computed shortly after midnight each day in the project's time zone. If the date range includes the current day, it will include statistics for the current day so far.

get/v1/projects/{project_id}/airtime_stats

Request

  • Base URL: https://api.telerivet.com
  • URL: https://api.telerivet.com/v1/projects/{project_id}/airtime_stats
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://telerivet.com/oauth/authorize, token URL https://api.telerivet.com/oauth/token)

Path parameters

project_idstring required

ID of the Project

Query parameters

start_datestring required

Start date of airtime statistics, in YYYY-MM-DD format

end_datestring required

End date of airtime statistics (inclusive), in YYYY-MM-DD format

rollup'day' | 'week' | 'month' | 'year' | 'all'

Date interval to group by

propertiesstring[]

Comma separated list of properties to group by. The provider_category property combines the provider type and category ID (e.g. main.airtime.dtone/1); also group by category_name to return the category's display name.

metricsstring required

Comma separated list of metrics to return (summed for each distinct value of the requested properties). Supported metrics are count (the number of successful transactions), value.<currency> (the face value of the airtime received by the recipients, e.g. value.KES), and price.<currency> (the amount charged for the transactions, e.g. price.USD). Amounts are not converted between currencies: each value/price metric only includes transactions denominated in the specified ISO 4217 currency, and transactions without a numeric currency value (such as bundles) are not included in any value metric.

filtersobject

Key-value pairs of properties and corresponding values; the returned statistics will only include successful airtime transactions where the property matches the provided value. Only the following properties are supported for filters: country, operator_name, product_id, provider_id, provider_category

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.