# Get a batch summary

Retrieve a summary of a batch call operation, including statistics on completed, failed, in-progress, and queued calls.  This provides an overview of the batch execution state and individual call session states.

Endpoint: GET /v2/projects/{projectId}/batches/{batchId}
Version: 2.0.58
Security: BasicAuth, SinchOAuth2

## Path parameters:

  - `projectId` (string, required)
    The ID of the project.

  - `batchId` (string, required)
    The ID of the batch.

## Response 200 fields (application/json):

  - `batchId` (string, required)
    Unique identifier of the batch call operation (ULID).
Use this value to retrieve the batch details ([GET] /v2/projects/{projectId}/batches/{batchId}/details) or stop processing ([DELETE] /v2/projects/{projectId}/batches/{batchId}).

  - `sessionCount` (integer, required)
    Total number of call sessions requested in this batch.
    Example: 100

  - `queued` (integer, required)
    Number of call sessions that are queued and waiting to be initiated (not yet in progress).
    Example: 5

  - `inProgress` (integer, required)
    Number of call sessions that are in progress.
    Example: 2

  - `completed` (integer, required)
    Number of call sessions that have completed successfully.
    Example: 93

  - `expired` (integer, required)
    Number of queued call sessions that were not initiated before the batch TTL (ttlSeconds) elapsed and therefore expired.

  - `requestedCps` (integer, required)
    Requested maximum call initiation rate, in calls per second (CPS), for this batch.
Actual CPS may be lower depending on routing, carrier, and platform capacity, as well as account limitations.
    Example: 10

  - `endTime` (string)
    Timestamp (RFC 3339) when the batch finished processing (all call sessions reached a final state). Returns

Omitted if the batch is still in progress or has not completed yet.

  - `ttlSeconds` (integer)
    Batch time-to-live (TTL) in seconds. The maximum amount of time the platform will keep attempting to start queued call sessions in this batch.
When the TTL expires, any call sessions that have not yet been initiated will stop being processed (calls already in progress are not affected).
    Example: 10800

## Response 400 fields (application/problem+json):

  - `type` (string, required)
    URI that identifies the problem type and links to the corresponding error documentation.

  - `title` (string, required)
    Human-readable short summary of the problem type.

  - `detail` (string, required)
    Human-readable explanation of the specific problem occurrence.
    Example: "The request body is invalid or malformed."

  - `instance` (string, required)
    URI reference that identifies the specific occurrence of the problem (typically the request path).
    Example: "/v2/projects/5c5bf2b1-35ae-4825-ab89-457e07bb60e6/calls/01ARZ3NDEKTSV4RRFFQ69G5FAA"

## Response 401 fields (application/problem+json):

  - `type` (string, required)
    URI that identifies the problem type and links to the corresponding error documentation.

  - `title` (string, required)
    Human-readable short summary of the problem type.

  - `detail` (string, required)
    Human-readable explanation of the specific problem occurrence.
    Example: "The token is missing, invalid, or has expired."

  - `instance` (string, required)
    URI reference that identifies the specific occurrence of the problem (typically the request path).
    Example: "/v2/projects/5c5bf2b1-35ae-4825-ab89-457e07bb60e6/calls/01ARZ3NDEKTSV4RRFFQ69G5FAA"

## Response 403 fields (application/problem+json):

  - `type` (string, required)
    URI that identifies the problem type and links to the corresponding error documentation.

  - `title` (string, required)
    Human-readable short summary of the problem type.

  - `detail` (string, required)
    Human-readable explanation of the specific problem occurrence.
    Example: "The request was rejected."

  - `instance` (string, required)
    URI reference that identifies the specific occurrence of the problem (typically the request path).
    Example: "/v2/projects/5c5bf2b1-35ae-4825-ab89-457e07bb60e6/calls/01ARZ3NDEKTSV4RRFFQ69G5FAA"

## Response 404 fields (application/problem+json):

  - `type` (string, required)
    URI that identifies the problem type and links to the corresponding error documentation.

  - `title` (string, required)
    Human-readable short summary of the problem type.

  - `detail` (string, required)
    Human-readable explanation of the specific problem occurrence.
    Example: "The requested resource was not found."

  - `instance` (string, required)
    URI reference that identifies the specific occurrence of the problem (typically the request path).
    Example: "/v2/projects/5c5bf2b1-35ae-4825-ab89-457e07bb60e6/calls/01ARZ3NDEKTSV4RRFFQ69G5FAA"

## Response 429 fields (application/problem+json):

  - `type` (string, required)
    URI that identifies the problem type and links to the corresponding error documentation.

  - `title` (string, required)
    Human-readable short summary of the problem type.

  - `detail` (string, required)
    Human-readable explanation of the specific problem occurrence.
    Example: "Rate limit exceeded. Please slow down your request rate and retry after the indicated period."

  - `instance` (string, required)
    URI reference that identifies the specific occurrence of the problem (typically the request path).
    Example: "/v2/projects/5c5bf2b1-35ae-4825-ab89-457e07bb60e6/calls"

## Response 500 fields (application/problem+json):

  - `type` (string, required)
    URI that identifies the problem type and links to the corresponding error documentation.

  - `title` (string, required)
    Human-readable short summary of the problem type.

  - `detail` (string, required)
    Human-readable explanation of the specific problem occurrence.
    Example: "An unexpected error occurred on the server."

  - `instance` (string, required)
    URI reference that identifies the specific occurrence of the problem (typically the request path).
    Example: "/v2/projects/5c5bf2b1-35ae-4825-ab89-457e07bb60e6/calls/01ARZ3NDEKTSV4RRFFQ69G5FAA"