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 by Redox product
Retrieve transaction usage metrics for one of your organization's Redox products for a particular time range. Metrics include counts of total transactions or transactions over time.
You can modify the query by date range and duration (i.e., day or month).
cURL request example
Path Parameters
- organizationIdrequired, string
Identifies the Redox organization that you're operating in.
- productClassificationIdrequired, string
Contains the UUID of the product classification that you want to retrieve transaction counts for.
Query Parameters
- startDaterequired, 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.
- endDaterequired, 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.
- aggregateByrequired, string
Defines the period of time for transaction counts over time, whether by day or month.
- metaobject
- versionstring
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.
- payloadobject
- startDatestring
Contains the date-time in ISO 8601 format to define the start of the date range for results.
- endDatestring
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.
- aggregateBystring
Defines the time window for grouping individual logs together, whether by day or month.
Possible Values:day
,month
- productClassificationIdstring
Displays the Redox product classification ID that the metrics pertain to.
- aggregateMetricsobject
Contains the properties for aggregate value metrics (e.g., total count).
- totalCountnumber
Lists the total count of logs occurring within the date range.
- connectionStatsArray of object
Contains all product connections and their associated log metrics.
- connectionIdnumber
Displays the connection identifier for the contained metrics.
- namestring
Displays the name of this connection. Usually this is typically your connection's organization name.
- aggregateMetricsobject
Contains the properties for aggregate value metrics (e.g., total count).
- totalCountnumber
Lists the total count of logs occurring within the date range.
- dataPointsArray of object
Contains the over-time data points within the specified time range for this connection.
- startDateTimestring
Contains the date-time in ISO 8601 format to define the start of the date range for this data point.
- endDateTimestring
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.
- countnumber
Defines the total count of logs that occurred within the specified date range of this data point.
- cumulativeSumnumber
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.
Contains the payload and metadata returned for Get transaction metrics by Redox product
.