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

# Read a time-series field across a config's records

> Reads one indexed history.series.fields field from the records-series bucket index, ascending by effective_at then record_id. Backed by a daily bucket index, not the raw event stream. Once the set is deleted, root and admin can still read its buckets; the field is then not checked.



## OpenAPI

````yaml /api-reference/endpoint/records/openapi.json get /records/{config_id}/series
openapi: 3.1.0
info:
  title: Records API
  version: 1.1.0
  description: >-
    Record configurations (schemas, views, versions) and the records that
    conform to them. Record IDs are server-generated, config IDs are
    client-supplied (`^[a-zA-Z0-9_-]+$`). Configs and records are updated with
    PUT: a config update applies only the fields sent, a record update merges
    `data`. Editing a config schema does not retroactively re-validate existing
    records. Publish a config version to snapshot the stored config; list and
    read versions to see its history.
servers:
  - url: https://api.quiva.ai
    description: Production API server
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: Record Configs
    description: >-
      Manage record configuration schemas. Each configuration defines the
      structure (fields, types, validation rules) that records must conform to.
  - name: Records
    description: >-
      Manage individual data records. Each record belongs to exactly one
      configuration and its data is validated against that configuration's
      schema.
  - name: Record Config Collections
    description: Groups of record configs.
  - name: Record Config Versions
    description: Published snapshots of a record config.
  - name: Record History
    description: The change history of a record.
  - name: Record Assessment
  - name: Strategy and Simulation
  - name: Record Metrics
paths:
  /records/{config_id}/series:
    parameters:
      - name: config_id
        in: path
        required: true
        description: >-
          ID of a record configuration whose history.mode is timeseries. The
          literal path segment "series" is matched before the {id} parameter of
          /records/{config_id}/{id}, so a record cannot be named "series".
        schema:
          type: string
    get:
      tags:
        - Record History
      summary: Read a time-series field across a config's records
      description: >-
        Reads one indexed history.series.fields field from the records-series
        bucket index, ascending by effective_at then record_id. Backed by a
        daily bucket index, not the raw event stream. Once the set is deleted,
        root and admin can still read its buckets; the field is then not
        checked.
      operationId: getRecordSeries
      parameters:
        - name: field
          in: query
          required: true
          description: One of the config's history.series.fields.
          schema:
            type: string
        - name: record_ids
          in: query
          required: false
          description: >-
            Comma-separated record ids to narrow to, at most 50. Omitted reads
            every record under the config.
          schema:
            type: string
        - name: start
          in: query
          required: false
          description: RFC3339 or YYYY-MM-DD, inclusive lower bound on effective_at.
          schema:
            type: string
        - name: end
          in: query
          required: false
          description: >-
            RFC3339 or YYYY-MM-DD (end of that UTC day), inclusive upper bound
            on effective_at.
          schema:
            type: string
        - name: limit
          in: query
          required: false
          description: Default 1000, clamped to 1000.
          schema:
            type: integer
            default: 1000
            maximum: 1000
        - name: offset
          in: query
          required: false
          description: Default 0, at most 10000.
          schema:
            type: integer
            default: 0
            maximum: 10000
      responses:
        '200':
          description: >-
            Series points for the requested field, ascending by effective_at
            then record_id. Buckets whose payload lacks the field are omitted
            from results but counted in total_hits.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Response'
                  - properties:
                      body:
                        $ref: '#/components/schemas/RecordSeriesResponse'
        '400':
          description: >-
            Missing config_id or field, record_ids over 50 entries, an
            unparsable start/end/limit/offset,
            `{"code":"history_not_timeseries"}` when the config's mode is not
            timeseries, or `{"code":"series_field_unknown"}` when field is not
            one of the config's series.fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Record configuration not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: >-
            `{"code":"history_read_failed"}` — the underlying index search
            failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    Response:
      type: object
      properties:
        status_code:
          type: integer
          description: HTTP status code echoed in the response body.
        body:
          type: object
          description: Response payload.
    RecordSeriesResponse:
      type: object
      description: get.record-series reply, ascending by effective_at then record_id.
      properties:
        config_id:
          type: string
        field:
          type: string
        bucket:
          type: string
          enum:
            - day
        results:
          type: array
          items:
            $ref: '#/components/schemas/RecordSeriesPoint'
          description: >-
            Buckets whose payload lacks the requested field are omitted here,
            though they still count in total_hits. Gaps are gaps — nothing
            interpolates.
        results_total:
          type: integer
        total_hits:
          type: integer
          description: >-
            Matching buckets before the per-field filter is applied, so it can
            exceed results_total.
    ErrorResponse:
      type: object
      properties:
        status_code:
          type: integer
        body:
          type: object
          properties:
            error:
              type: string
              description: Human-readable error message.
      example:
        status_code: 400
        body:
          error: field 'rating' is required
    RecordSeriesPoint:
      type: object
      description: One day bucket's value for the requested field.
      properties:
        record_id:
          type: string
        bucket:
          type: string
          description: The bucket key, YYYY-MM-DD for day buckets.
        effective_at:
          type: string
          format: date-time
        version:
          type: integer
          description: >-
            The record's version when this bucket was last written. A late or
            corrected value overwrites the bucket and this changes.
        value:
          type: number
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.