GET /experimental/reports/time-series-transaction

Retrieves a transactions report that is aggregated by time periods.

Servers

Query parameters

Name Type Required Description
limit Integer No

Limits the number of collection items to be returned.

subaggregate String No

Report subaggregate.

Valid values:

  • "website"
  • "leads.term"
  • "leads.source"
  • "leads.medium"
  • "leads.subaffiliate"
  • "plan"
  • "leads.content"
  • "leads.affiliate"
  • "leads.campaign"
  • "gateway-account"
  • "currency"
  • "leads.sales-agent"

Default value: "gateway-account"

type String No

Type of report aggregation.

Valid values:

  • "count"
  • "incomplete-rate"
  • "approval-rate"
  • "amount"

Default value: "count"

periodStart String No

Date and time when the report starts. If no value is provided, the report begins on the first day of the current month.

periodEnd String No

Date and time when the report ends. If no value is provided, the report ends on the last day of the current month.

offset Integer No

Specifies the starting point within the collection of items to be returned.

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.