API Reference

payout

get
https://api.heymantle.com/v1/api/core/v1/metrics/payout

Returns current period payout summary data. When interval=payout is specified, also includes historical time series data by payout periods.

Important Notes about Date Ranges:

  • Date ranges include complete payout periods that fall entirely within the requested range
  • Partial payout periods that extend beyond the requested dates are excluded
  • The current date may not be included if no payout period has completed yet
  • Payout periods are typically 15-day windows (1st-15th and 16th-end of month)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
appIds
array of strings

Filter by specific app IDs (comma-separated)

appIds
appInstallationIds
array of strings

Filter by specific app installation IDs (comma-separated)

appInstallationIds
string

Filter by customer segment ID

string

Filter by specific customer ID

string
enum

Predefined time period (overrides periodStart/periodEnd)

Allowed:
date

Custom start date for the payout period (YYYY-MM-DD format). Only complete payout periods that fall entirely within the date range will be included.

date

Custom end date for the payout period (YYYY-MM-DD format). Only complete payout periods that fall entirely within the date range will be included.

string
enum

Use 'payout' to get time series data by payout periods

Allowed:
Responses

Updated 12 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 days ago