Home
API reference
Platform API reference
Platform API
Transaction Usage
Export metrics

Export metrics

get/v1/organizations/{organizationId}/transaction-metrics/export
Page View

Transaction usage endpoints allow you to review and export transaction usage data for your current Redox contract. This allows you to easily monitor your usage and limits as you go.

You can get details for all the Redox product(s) in your contract, retrieve metrics by product type, and export metrics.

Export metrics

Review transaction usage metrics for your Redox product in a CSV file. Or, you may use the CSV file to import metrics into your own app dashboard.

Metrics include counts of total transactions or transactions over time. You can modify the query by date range, duration (i.e., day or month), or a specific connection.

Request parameters

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/organizations/{organizationId}/transaction-metrics/export' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json'

Path Parameters

  • organizationId
    required, string

    Identifies the Redox organization that you're operating in.

Query Parameters

  • productClassificationId
    string

    Contains the UUID of the product classification that you want to retrieve transaction counts for.

  • startDate
    required, string

    Contains the date-time in ISO 8601 format to define the beginning of the date range for the transaction metrics you want to review.

  • endDate
    required, string

    Contains the date-time in ISO 8601 format to define the end of the date range for the transaction metrics you want to review. The end date-time is exclusive, which means results may be returned up to this date-time, but not including it.

  • aggregateBy
    required, string

    Defines the period of time for transaction counts over time, whether by day or month.

  • connectionId
    number

    Contains the connection ID for filtering counts and over-time data to a specific connection.

Response fields and example

Example payload generated from schema
1
"Product,ConnectionId,ConnectionName,StartDateTime,EndDateTime,Count\nd222fc9e-039a-4486-8be4-cdebcc4c9a06,122,Redox Org,2023-01-01T00:00:00.000Z,2023-02-01T00:00:00.000Z,21457"