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 customer analytics by attribute(s).

Scopes:

Filter by specific conditions defined in the model.

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

• Allowed scopes: merchantId, channelPartnerId

• Example: ?filter[merchantId]=123456

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

• Example: ?filter[channelPartnerId]=123456

Tags:

Filter by user-applied tags on the underlying payments. Use a leading ! to exclude a tag. Comma-separated values are OR'd for includes; excludes remove rows tagged with any listed tag.

• Example: ?filter[tag]=needs-review,priority
• Example: ?filter[tag]=!archived
• Example: ?filter[tag]=needs-review,!archived