Grid Status Dataset Audit API

openapi: 3.2.0
info:
  title: Grid Status Dataset Audit API
  version: 1.3.0
servers:
- url: https://api.gridstatus.io/v1
tags:
- name: Dataset Audit
paths:
  /datasets/{dataset_id}/audit:
    get:
      tags:
      - Dataset Audit
      summary: Get Dataset Audit
      description: 'Returns audit data by market date for a given dataset


        * market_date: The market date for which the audit data is being returned


        * number_of_datapoints: The total number of rows


        * number_of_unique_time_index_values: The total number of unique time index

        values


        * number_of_unique_subseries_index_values: The total number of unique

        subseries index values


        * number_of_unique_publish_times_on_publish_date: The total number of

        unique publish time values where the publish time occurred on the given

        market date'
      operationId: get_dataset_audit_v1_datasets__dataset_id__audit_get
      parameters:
      - name: dataset_id
        in: path
        required: true
        schema:
          type: string
          title: Dataset Id
      - name: api_key
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: API key for authentication (query)
          title: Api Key
        description: API key for authentication (query)
      - name: return_format
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/ReturnFormat'
          description: The return format of the response
          default: json
        description: The return format of the response
      - name: download
        in: query
        required: false
        schema:
          type: boolean
          description: Whether to download the file or not
          default: false
          title: Download
        description: Whether to download the file or not
      - name: json_schema
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/JSONSchema'
          description: The json schema of the response
          default: array-of-objects
        description: The json schema of the response
      - name: x-api-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: API key for authentication (header)
          title: X-Api-Key
        description: API key for authentication (header)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetAuditResponse'
              example:
                status_code: 200
                data:
                - market_date: '2025-01-01'
                  number_of_datapoints: 100
                  number_of_unique_time_index_values: 100
                  number_of_unique_subseries_index_values: 100
                  number_of_unique_publish_times_on_publish_date: 100
                - market_date: '2025-01-02'
                  number_of_datapoints: 100
                  number_of_unique_time_index_values: 100
                  number_of_unique_subseries_index_values: 100
                  number_of_unique_publish_times_on_publish_date: 100
                meta:
                  page: 1
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ReturnFormat:
      type: string
      enum:
      - json
      - csv
      title: ReturnFormat
    DatasetAuditResponse:
      properties:
        status_code:
          type: integer
          title: Status Code
        data:
          items:
            $ref: '#/components/schemas/DatasetAudit'
          type: array
          title: Data
      type: object
      required:
      - status_code
      - data
      title: DatasetAuditResponse
    DatasetAudit:
      properties:
        market_date:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Market Date
        number_of_datapoints:
          anyOf:
          - type: integer
          - type: 'null'
          title: Number Of Datapoints
        number_of_unique_time_index_values:
          anyOf:
          - type: integer
          - type: 'null'
          title: Number Of Unique Time Index Values
        number_of_unique_subseries_index_values:
          anyOf:
          - type: integer
          - type: 'null'
          title: Number Of Unique Subseries Index Values
        number_of_unique_publish_times_on_publish_date:
          anyOf:
          - type: integer
          - type: 'null'
          title: Number Of Unique Publish Times On Publish Date
      type: object
      required:
      - market_date
      - number_of_datapoints
      - number_of_unique_time_index_values
      - number_of_unique_subseries_index_values
      - number_of_unique_publish_times_on_publish_date
      title: DatasetAudit
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    JSONSchema:
      type: string
      enum:
      - array-of-objects
      - array-of-arrays
      title: JSONSchema
externalDocs:
  description: 'GridStatus documentation. Human docs: https://docs.gridstatus.io/developers. Ask a natural-language question (RAG search): append a URL-encoded question to https://docs.gridstatus.io/?ask='
  url: https://docs.gridstatus.io/llms.txt
x-tagGroups:
- name: API Endpoints
  tags:
  - API Info
  - Block Pricing Data
  - Dataset Metadata
  - Query Data
  - Dataset Updates
  - Reports
x-rag-search:
  description: Natural-language question answering over the GridStatus documentation. Substitute a URL-encoded question for {question}.
  url_template: https://docs.gridstatus.io/?ask={question}
  llms_txt: https://docs.gridstatus.io/llms.txt
x-provenance:
  method: harvested
  publisher: Grid Status
  source: https://api.gridstatus.io/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)