GET /experimental/histograms/transactions

Retrieves transaction histogram report data.

Servers

Query parameters

Name Type Required Description
metric String No

Metric on which the report is based.

Valid values:

  • "sales"
  • "all_sales_count"
  • "auth_approval_count"
  • "disputes_count"
  • "avg_sales"
  • "refunds"
  • "refunds_count"
  • "disputes_rate"
  • "credits_count"
  • "approval"
  • "auth_approval"
  • "unapproved_count"
  • "credits"
  • "sales_count"

Default value: "sales_count"

aggregationPeriod String No

Aggregation period of the report.

Valid values:

  • "month"
  • "day"
  • "minute"
  • "hour"

Default value: "day"

filter String No

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

periodStart String No

Date and time when the report starts. The default value depends on the aggregation period:

  • 24 hours ago for minute aggregation.
  • First day of the current month for other aggregation periods.
periodEnd String No

Date and time when the report ends. The default value depends on the aggregation period:

  • Current time for minute aggregation.
  • Last day of the current month for other aggregation periods.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.