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

# Records summary

> Returns a summary of records extracted and exported within the specified date range.
Useful for answering questions like "How many records did the agent download yesterday?"



## OpenAPI

````yaml GET /api/v1/analytics/records/summary
openapi: 3.0.1
info:
  title: Sequentum Cloud API
  description: API endpoints for Sequentum Cloud
  version: v1
servers: []
security:
  - ApiKey: []
    Bearer: []
paths:
  /api/v1/analytics/records/summary:
    get:
      tags:
        - ApiAnalytics
      summary: Get records summary for a date range
      description: >-
        Returns a summary of records extracted and exported within the specified
        date range.

        Useful for answering questions like "How many records did the agent
        download yesterday?"
      parameters:
        - name: startDate
          in: query
          description: Start date for the range (ISO format, defaults to yesterday)
          schema:
            type: string
            format: date-time
        - name: endDate
          in: query
          description: End date for the range (ISO format, defaults to now)
          schema:
            type: string
            format: date-time
        - name: agentId
          in: query
          description: 'Optional: Filter by specific agent ID'
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: Returns the records summary
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordsSummaryApiModel'
        '400':
          description: If the date range is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '401':
          description: If the API key is missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    RecordsSummaryApiModel:
      type: object
      properties:
        startDate:
          type: string
          description: Start date of the range
          format: date-time
        endDate:
          type: string
          description: End date of the range
          format: date-time
        totalRecordsExtracted:
          type: integer
          description: Total records extracted across all runs
          format: int64
        totalRecordsExported:
          type: integer
          description: Total records exported across all runs
          format: int64
        totalErrors:
          type: integer
          description: Total errors across all runs
          format: int64
        totalPageLoads:
          type: integer
          description: Total page loads across all runs
          format: int64
        runCount:
          type: integer
          description: Number of runs included in this summary
          format: int32
        agentId:
          type: integer
          description: Optional agent ID filter
          format: int32
          nullable: true
      additionalProperties: false
      description: Response model for records summary
    BadRequestError:
      type: object
      properties:
        statusCode:
          type: integer
          format: int32
        statusDescription:
          type: string
          nullable: true
        message:
          type: string
          nullable: true
          readOnly: true
        severity:
          $ref: '#/components/schemas/ErrorSeverity'
        errorCode:
          type: string
          description: "Optional machine-readable error code. When present, clients should switch on this\r\nvalue rather than parsing Sequentum.Enterprise.Core.ControllerError.Message. Omitted from the response when null."
          nullable: true
      additionalProperties: false
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
      additionalProperties: {}
    ErrorSeverity:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
      type: integer
      description: >-
        `0` = `Error`; `1` = `Unexpected`; `2` = `Fatal`; `3` = `Warning`; `4` =
        `Info`
      format: int32
  securitySchemes:
    ApiKey:
      type: apiKey
      description: >-
        API Key authorization header. Example: "Authorization: ApiKey
        {your-api-key}"
      name: Authorization
      in: header
    Bearer:
      type: http
      description: 'OAuth 2.0 Bearer token. Example: "Authorization: Bearer {access-token}"'
      scheme: bearer
      bearerFormat: JWT

````