v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB

Consumption

Get a breakdown of your credit consumption for ETL Users

Returns the number of credits you have been charged for ETL Users in a given period, and which users contributed charges. Because ETL Users are metered on monthly active unique users, your consumedFrom and consumedBefore parameters should reflect the period for a single monthly invoice. This data refreshes every three hours to reflect recent credit usage.

get/v1/consumption/etl-users

Query parameters

consumedFromstring date-time required

First date+time to include in results (inclusive)

consumedBeforestring date-time required

Date+time before which results should be included (exclusive)

Response

Successful

consumedBeforestring date-time

Date+time before which results are included (UTC) (exclusive)

consumedFromstring date-time

First date+time included in results (UTC) (inclusive)

creditsnumber double

The total credits charged during this period

Example response

{
  "chargedUsers": [
    {
      "username": "User 6"
    },
    {
      "username": "User 7"
    }
  ],
  "consumedBefore": "2024-01-31T00:00:00.000Z",
  "consumedFrom": "2024-01-01T00:00:00.000Z",
  "credits": 100
}