ObservePoint · OpenAPI Overlay 1.0.0

API Evangelist enhancements for the ObservePoint Grid Reporting API

4 actions 4 updates update extends ../openapi/observepoint-grid-reports-api-openapi.yml
Derived by API Evangelist Built from the contracts ObservePoint publishes. ObservePoint did not publish this file.
View Overlay File View on GitHub Overlay Specification

What the actions change

contactx-documentation-urlx-examples-urlx-grid-queryx-rate-limitsx-depends-on

Targets 2

$.info
$.paths['/v3/reports/grid/{gridEntityType}'].post

OpenAPI Overlay

Raw ↑
overlay: 1.0.0
info:
  title: API Evangelist enhancements for the ObservePoint Grid Reporting API
  version: 1.0.0
extends: ../openapi/observepoint-grid-reports-api-openapi.yml
x-provenance:
  generated: '2026-08-26'
  method: generated
  source: >-
    Enhancements derived from https://api-docs.observepoint.com/sections/grid-api-intro,
    /sections/grid-api-filters, /sections/grid-api-sorting, /sections/grid-api-grouping,
    /sections/grid-api-pagination, /sections/grid-api-exports and /sections/rate-limiting, applied over
    the verbatim spec at https://api-docs.observepoint.com/_bundle/openapi/GRID-API.openapi.yaml.
actions:
- target: $.info
  description: Add contact and documentation pointers.
  update:
    contact:
      name: ObservePoint
      url: https://www.observepoint.com/contact-us/
    x-documentation-url: https://api-docs.observepoint.com/sections/grid-api-intro
    x-examples-url: https://api-docs.observepoint.com/sections/grid-api-examples
- target: $.info
  description: >-
    Record the Grid query language — the operator set, the pagination fields and the grouping/sorting
    surface — which the docs specify fully but the contract only implies through generic schemas.
  update:
    x-grid-query:
      filter_shape: '{ filteredColumn: { columnId }, operator, arg }'
      operators:
      - string_contains
      - string_regex
      - string_contains_multi
      - integer_in
      - number_between
      - date_time_between
      - date_time_relative
      - is_present
      - integer_list_contains
      pagination:
        location: request body
        size: 10-10000
        page: zero-based
        response_envelope: metadata.pagination
      sorting: multi-column with explicit order
      grouping: group mode with aggregate functions
      column_discovery: GET /v3/reports/grid/{gridEntityType}/schema (getGridSchema)
      source: https://api-docs.observepoint.com/sections/grid-api-filters
- target: $.info
  description: Record the rate-limit contract, absent from every operation.
  update:
    x-rate-limits:
      scope: per-api-key
      requests_per_minute_range: 100-1000
      status_on_exhaustion: 429
      response_headers: none published
      source: https://api-docs.observepoint.com/sections/rate-limiting
- target: $.paths['/v3/reports/grid/{gridEntityType}'].post
  description: >-
    Flag the discovery dependency — a caller must read the entity schema before it can name a valid
    columnId in a filter, sort or grouping clause.
  update:
    x-depends-on:
      operationId: getGridSchema
      reason: columnId values are defined per grid entity type and must be read from the schema endpoint first.

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/observepoint-grid-reports-api-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.