Zenodo Statistics API

Statistics and analytics endpoints

OpenAPI Specification

zenodo-statistics-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Zenodo REST Access Statistics API
  description: 'REST API for Zenodo, the free open research data repository operated by CERN and built on InvenioRDM. Provides programmatic access to deposits (draft records), published records, file management, communities, vocabularies, OAI-PMH sets, requests, users, groups, statistics, and audit logs. Every published record receives a DOI for persistent citation. Authenticate with a personal access token passed as a Bearer token.

    '
  version: 12.0.0
  contact:
    name: Zenodo Developer Documentation
    url: https://developers.zenodo.org/
  license:
    name: MIT License
    url: https://opensource.org/licenses/MIT
  x-upstream-spec: https://github.com/inveniosoftware/invenio-openapi
servers:
- url: https://zenodo.org
  description: Zenodo production instance
- url: https://sandbox.zenodo.org
  description: Zenodo sandbox (testing)
security:
- BearerAuth: []
tags:
- name: Statistics
  description: Statistics and analytics endpoints
paths:
  /api/stats:
    post:
      summary: Get record statistics
      tags:
      - Statistics
      operationId: getStatistics
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              views:
                stat: record-view
                params:
                  recid: record-id
      responses:
        '201':
          $ref: '#/components/responses/Created'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  responses:
    Created:
      description: Resource created successfully
      content:
        application/json:
          schema:
            type: object
    BadRequest:
      description: Bad request - invalid input parameters
    InternalServerError:
      description: Internal server error
    Unauthorized:
      description: Unauthorized - authentication required
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Personal access token issued from the Zenodo account settings