Histograms

Use histogram operations to generate transaction histogram reports with cohorts and periods. For information on the invoice resource, see Resources.

Operations

Retrieve transaction histogram report data
Experimental

Request

Retrieves transaction histogram report data.

Security
SecretApiKey or JWT
Query
periodStartstring, (date-time)

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.
periodEndstring, (date-time)

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.
aggregationPeriodstring

Aggregation period of the report.

Default:"day"
Enum:"minute""hour""day""month"
metricstring

Metric on which the report is based.

Default:"sales_count"
Enum:"approval""auth_approval""avg_sales""refunds""refunds_count""sales""sales_count""all_sales_count""auth_approval_count""disputes_count"
filterstring

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.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/experimental/histograms/transactions?periodStart=2019-08-24T14%3A15%3A22Z&periodEnd=2019-08-24T14%3A15%3A22Z&aggregationPeriod=minute&metric=approval&filter=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Transaction report retrieved.

Bodyapplication/json
dataArray of objects

Histogram data.

Response
{
  "data": [
    { … }
  ]
}