---
title: "Get Credit Aggregation"
method: POST
path: "/v1/credits/aggregation"
tags: ["Credits"]
---

# Get Credit Aggregation

`POST /v1/credits/aggregation`

## Request body

- CreditAggregationRequest
  - `request_context` object, nullable
  - `from_date` string, required — ISO 8601 datetime string for start date
  - `to_date` string, required — ISO 8601 datetime string for end date
  - `mode` 'timely' | 'endpoints', required — Aggregation mode
  - `resolution` 'hour' | 'day' | 'month' — Aggregation resolution (required for timely mode, optional for endpoints mode)
  - `timezone` string — Timezone for aggregation, defaults to UTC
  - `key_name` string — Optional API key name to scope aggregation results

## Response `200`

Successful Response

- CreditAggregationResponse — This is base response model for all responses in partner service.
  - `response_context` ResponseContext, required
    - `correlation_id` string, required
    - `request_status` 'success' | 'miss' | 'failure', required — The `RequestStatus` class is an enumeration that defines the possible statuses of a request. This enum is used to indicate whether a request was successful, missed, or failed. It ensures consistent handling of request statuses across the application. Attributes: SUCCESS: Indicates that the request was successfully processed. MISS: Indicates that the request did not find any matching data. FAILURE: Indicates that the request encountered an error or failure.
    - `time_took_in_seconds` number, required
  - `from_date` string, required — ISO 8601 datetime string for start date
  - `to_date` string, required — ISO 8601 datetime string for end date
  - `mode` string, required — Aggregation mode
  - `resolution` 'hour' | 'day' | 'month' — Aggregation resolution (not applicable for endpoints mode)
  - `timezone` string, required — Timezone used for aggregation
  - `total_credits` integer, required — Total credits consumed in the period
  - `aggregations` object[], required — Array of aggregation data points

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/explorium-ai/apis/partner-service.md) · [All operations](https://skmtc.net/explorium-ai/apis/partner-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/explorium-ai/partner-service/revisions/cdff11b1b0d3/schema)