> ## Documentation Index
> Fetch the complete documentation index at: https://docs.repdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Responses per campaign

> # Description

Get the amount of responses and screen-outs from a campaign of a project.

# Response

## 200 OK

```json
{
   "screenOutTotal": number,
   "total": number
}
```
where:

- `screenOutTotal`: amount of screen-outs.
- `total`: amount of responses completed.  

## 400 Bad Request

> If campaignId and/or projectId are missing.

## 401 Unauthorized

> The user doesn't have permissions.

## 500 Internal Server Error

> Error occurred while processing the request.

# Description

Get the amount of responses and screen-outs from a campaign of a project.

# Response

## 200 OK

```json theme={null}
{
   "screenOutTotal": number,
   "total": number
}
```

where:

* `screenOutTotal`: amount of screen-outs.
* `total`: amount of responses completed.

## 400 Bad Request

> If campaignId and/or projectId are missing.

## 401 Unauthorized

> The user doesn't have permissions.

## 500 Internal Server Error

> Error occurred while processing the request.

##### Query Parameters

| Parameter    | Description | Required | Example |
| ------------ | ----------- | -------- | ------- |
| `projectId`  | —           | No       | —       |
| `campaignId` | —           | No       | —       |


## OpenAPI

````yaml GET /responses-capture-service/v1/responses/responsesTotalPerCampaign
openapi: 3.0.3
info:
  title: SightX API
  version: 1.0.0
  description: >-
    SightX REST API documentation. Most responses are JSON; some export
    endpoints return files. API access is a paid add-on — contact
    sales@sightx.io for details.
servers:
  - url: https://auth.admin.sightx.io
    description: Authentication (Production)
  - url: https://auth.staging-admin.sightx.io
    description: Authentication (Staging)
security:
  - AuthorizationHeader: []
paths:
  /responses-capture-service/v1/responses/responsesTotalPerCampaign:
    get:
      summary: Responses per campaign
      description: >-
        # Description


        Get the amount of responses and screen-outs from a campaign of a
        project.


        # Response


        ## 200 OK


        ```json

        {
           "screenOutTotal": number,
           "total": number
        }

        ```

        where:


        - `screenOutTotal`: amount of screen-outs.

        - `total`: amount of responses completed.  


        ## 400 Bad Request


        > If campaignId and/or projectId are missing.


        ## 401 Unauthorized


        > The user doesn't have permissions.


        ## 500 Internal Server Error


        > Error occurred while processing the request.
      operationId: >-
        responses-per-campaign-get-responses-capture-service-v1-responses-responsestotalpercampaign
      parameters:
        - name: Authorization
          in: header
          required: true
          description: Authorization token
          schema:
            type: string
        - name: projectId
          in: query
          required: false
          schema:
            type: string
        - name: campaignId
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Responses per campaign
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                total: 8
                screenOutTotal: 0
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '500':
          description: Internal server error
      servers:
        - url: https://responses.sightx.io
components:
  securitySchemes:
    AuthorizationHeader:
      type: apiKey
      in: header
      name: Authorization
      description: Access token obtained from the m2m-token endpoint.

````