The organization ID

The period to calculate analytics for relative to the current time. Options: 1h, 24h, 7d, 30d, 3mo, 6mo, 1y

The interval size to calculate analytics for. Defaults to 'day'. Options: hour, day, week, month, year

The start time of the period to calculate analytics for (cannot be used in combination with forLast param). Example: ?periodStart=2025-05-29

The end time of the period to calculate analytics for (cannot be used in combination with forLast param). Example: ?periodEnd=2025-05-30

Filter the payout analytics by attribute(s).

Dynamic operators:

Follow the "=" with a comparison operator and the value you want to filter by.

• Available operators: =, !=, <, <=, >, >=.

• Allowed attributes: settlement_date, deposit_date

• Example (less than or equal to): ?filter[settlementDate]=<=2025-05-29T00:00:00Z

Scopes:

Filter by specific conditions defined in the model.

NOTE: either merchantId or channelPartnerId must be provided in the query filters.

• Allowed scopes: settlementDateBetween, depositDateBetween, merchantId, channelPartnerId

• Example: ?filter[settlementDateBetween]=2025-05-29,2025-05-30

• Example: ?filter[merchantId]=123456

• Example: ?filter[merchantId]=123456,789012 (multiple merchant IDs)

• Example: ?filter[channelPartnerId]=123456