Home
API reference
Platform API reference
Platform API
Transaction Usage
Get transaction metrics

Get transaction metrics

get/v1/organizations/{organizationId}/product-classifications/{productClassificationId}/transaction-metrics
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.

Get transaction metrics

Retrieve transaction usage metrics of your organization's Redox product(s) for a particular time range or connection. 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 connection.

Request parameters

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/organizations/{organizationId}/product-classifications/{productClassificationId}/transaction-metrics' \
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.

  • productClassificationId
    required, string

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

Query Parameters

  • 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
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "salesforceSubscription": {
7
      "productClassificationId": "4d1d5191-7d62-4f29-a26e-3e28d9082a3a",
8
      "productClassificationName": "cm_access_ceq",
9
      "limit": "4d1d5191-7d62-4f29-a26e-3e28d9082a3a",
10
      "consumptionPeriod": "Month",
11
      "startDate": "2023-01-01",
12
      "endDate": "2023-12-31",
13
      "resetDate": "2023-12-31"
14
    },
15
    "startDate": "2023-01-01T00:00:00.000Z",
16
    "endDate": "2024-01-01T00:00:00.000Z",
17
    "totalProductTransactions": 21478,
18
    "aggregateMetrics": {
19
      "totalCount": 21478,
20
      "dataPoints": [
21
        {
22
          "startDateTime": "2023-01-01T00:00:00.000Z",
23
          "endDateTime": "2023-02-01T00:00:00.000Z",
24
          "count": 9056,
25
          "cumulativeSum": 36803
26
        }
27
      ]
28
    }
29
  }
30
}

    Contains the payload and metadata returned for Get transaction metrics.

  • meta
    object
    • version
      string

      Lists the major and minor version number for the format of the returned payload. The payload format or shape may change between minor versions, like including additional or extended fields in later versions. We include the version data in each response so that you have the option to handle the signaled differences.

  • payload
    object
    • salesforceSubscription
      object

      Contains an object with key details about an organization's Redox product subscription in the CRM (i.e., Salesforce).

      • productClassificationId
        string

        Displays a UUID for the Redox ID for the product classification.

      • productClassificationName
        string

        Displays the human-readable, internal name in the CRM for the Redox product classification.

      • limit
        number

        Defines the number of transactions purchased for the Redox product within the selected limit type.

      • consumptionPeriod
        string

        Defines the time window for the transaction limit. Month and Annual mean that transaction usage limit resets each calendar month or year respectively. Contract Term means that the transaction usage doesn't reset; instead, the limit lasts for the duration of the contract.

        Possible Values: Annual, Contract Term, Month
      • startDate
        string

        Contains the date-time in ISO 8601 format to define the start of the Redox product contract.

      • endDate
        string

        Contains the date-time in ISO 8601 format to define the end of the Redox product contract.

      • resetDate
        string

        Contains the date-time in ISO 8601 format to indicate the next time that the transaction limit window resets.

    • startDate
      string

      Contains the date-time in ISO 8601 format to define the start of the date range for results.

    • endDate
      string

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

    • totalProductTransactions
      number

      Lists the total number of transactions for the Redox product within the time range, regardless of any metadata filters or request parameters (e.g., connection ID).

    • aggregateMetrics
      object

      Contains the properties for total count and over-time data points for log metrics.

      • totalCount
        number

        Displays the total number of transactions over the time range with all filters or request parameters applied (e.g., connection ID).

      • dataPoints
        Array of object

        Displays the over-time data points within the specified time range.

        • startDateTime
          string

          Contains the date-time in ISO 8601 format to define the start of the date range for this data point.

        • endDateTime
          string

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

        • count
          number

          Defines the total count of logs that occurred within the specified date range of this data point.

        • cumulativeSum
          number

          Defines the total sum of logs that have occurred up to the end of this data point's date range, including all prior data points.