v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB
Consumption

Get a breakdown of your credit consumption for flat-rated products

Returns a breakdown of your credit consumption for flat-rated products, grouped by calendar day (per UTC) and then by the type of consumption and relevant dimensions. This data refreshes every three hours to reflect recent credit usage.

get/v1/consumption

Query parameters

consumedFromstring date required

First calendar date to include in results (inclusive)

consumedBeforestring date required

Calendar date before which results should be included (exclusive)

Response

Successful

Example response

{
  "results": [
    {
      "consumedFrom": "2024-01-01T00:00:00.000Z",
      "consumedBefore": "2024-01-02T00:00:00.000Z",
      "consumption": [
        {
          "consumptionType": "etl-compute",
          "dimensions": {
            "installationId": "1850bc49-c4a4-4f35-ab3c-827b849548b9"
          },
          "credits": 24
        },
        {
          "consumptionType": "orchestration",
          "dimensions": {
            "pipelineName": "projects/my-project/pipelines/daily-load.orch.yaml",
            "projectId": "d46a46c2-7ac4-41a8-b619-4ca34a7f003f",
            "environment": "default"
          },
          "credits": 16.2
        },
        {
          "consumptionType": "transformation",
          "dimensions": {
            "pipelineName": "projects/my-project/pipelines/enrich-customers.tran.yaml",
            "projectId": "d46a46c2-7ac4-41a8-b619-4ca34a7f003f",
            "environment": "default"
          },
          "credits": 9.6
        },
        {
          "consumptionType": "streaming",
          "dimensions": {
            "pipelineName": "projects/my-project/pipelines/cdc-stream",
            "projectId": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
          },
          "credits": 9.6
        },
        {
          "consumptionType": "data-loader-batch",
          "dimensions": {
            "pipelineId": "1732786524"
          },
          "credits": 50
        },
        {
          "consumptionType": "data-loader-cdc",
          "dimensions": {
            "pipelineId": "1732786525"
          },
          "credits": 60
        },
        {
          "consumptionType": "dpc-users",
          "dimensions": {
            "userEmail": "jane.doe@example.com"
          },
          "credits": 70
        }
      ]
    }
  ]
}