Dimensions Query API

The Query API from Dimensions — 1 operation(s) for query.

OpenAPI Specification

dimensions-query-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Dimensions Analytics Authentication Query API
  description: The Dimensions Analytics API provides programmatic access to research data (publications, grants, patents, clinical trials, datasets, policy documents) using the Dimensions Search Language (DSL). Authentication is via a JWT token obtained from POST /api/auth, and queries are issued against POST /api/dsl.
  version: '2.0'
servers:
- url: https://app.dimensions.ai/api
  description: Dimensions Analytics API
security:
- jwt: []
tags:
- name: Query
paths:
  /dsl/v2:
    post:
      tags:
      - Query
      summary: Execute a DSL query
      operationId: dslQuery
      requestBody:
        required: true
        content:
          text/plain:
            schema:
              type: string
              description: A DSL query string, e.g. `search publications return publications`
      responses:
        '200':
          description: Query results
          content:
            application/json:
              schema:
                type: object
components:
  securitySchemes:
    jwt:
      type: apiKey
      in: header
      name: Authorization
      description: Pass `JWT {token}` returned by /auth