Vertex Reports API

The Reports API from Vertex — 8 operation(s) for reports.

Operations 11

DELETE /api/v1/reports/results/{reportresultid} Hard-delete a report result and its generated artifact. #
GET /api/v1/reports/results/{reportresultid} Retrieve full metadata for a single report result by its ID, including… #
POST /api/v1/reports/results/{reportresultid}/cancel Request cancelation of a report result that is currently PENDING or PROCESSING. #
GET /api/v1/reports/{definitionid}/results/{reportresultid} Retrieve full metadata for a single report result, including pre-signed… #
DELETE /api/v1/reports/{reportid} Soft-delete a report definition by moving it to ARCHIVED status. #
GET /api/v1/reports/{reportid} Retrieve full metadata for a single report definition #
PUT /api/v1/reports/{reportid} Update an existing saved report definition. #
POST /api/v1/reports/{reportid}/results Execute a report definition and create a new report result. #
DELETE /api/v1/reports/{reportid}/schedules Delete all schedules associated with a specific report definition #
DELETE /api/v1/reports/{reportid}/schedules/{scheduleid} Delete a specific schedule associated with a given report definition. #
GET /api/v1/reports/{reportid}/{id} Retrieve all report results generated for a specific report definition, with… #

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API
curl "https://apis.io/api/v1/apis/vertex:vertex-reports-api"
All apis
curl "https://apis.io/api/v1/apis?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.

OpenAPI Specification

vertex-reports-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Vertex Reports API
  version: '2026-10-13'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-13: 23 operation(s) read from 8 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Vertex has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 5
    documentation: 18
    pages-with-code: 8
    pages-read: 8
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-13'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://developer.vertexinc.com/vat-compliance/docs/upload-customer-data-files
  - https://developer.vertexinc.com/vat-compliance/docs/using-the-vat-compliance-api
  - https://developer.vertexinc.com/oseries/docs
  - https://developer.vertexinc.com/oseries/docs/quick-start
  - https://developer.vertexinc.com/solutionreporting/docs/authentication
  - https://developer.vertexinc.com/solutionreporting/docs/using-the-solution-reporting-api
  - https://developer.vertexinc.com/smartcategorization/docs/authentication
  - https://developer.vertexinc.com/smartcategorization/docs/error-handling
servers:
- url: https://dash.readme.com
tags:
- name: Reports
paths:
  /api/v1/reports/results/{reportresultid}:
    delete:
      operationId: delete_api_v1_reports_results_reportresultid
      tags:
      - Reports
      summary: Hard-delete a report result and its generated artifact.
      x-source: https://developer.vertexinc.com/solutionreporting/docs/using-the-solution-reporting-api
      parameters:
      - name: reportresultid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_api_v1_reports_results_reportresultid
      tags:
      - Reports
      summary: Retrieve full metadata for a single report result by its ID, including…
      x-source: https://developer.vertexinc.com/solutionreporting/docs/using-the-solution-reporting-api
      parameters:
      - name: reportresultid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/reports/results/{reportresultid}/cancel:
    post:
      operationId: post_api_v1_reports_results_reportresultid_cancel
      tags:
      - Reports
      summary: Request cancelation of a report result that is currently PENDING or PROCESSING.
      x-source: https://developer.vertexinc.com/solutionreporting/docs/using-the-solution-reporting-api
      parameters:
      - name: reportresultid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/reports/{definitionid}/results/{reportresultid}:
    get:
      operationId: get_api_v1_reports_definitionid_results_reportresultid
      tags:
      - Reports
      summary: Retrieve full metadata for a single report result, including pre-signed…
      x-source: https://developer.vertexinc.com/solutionreporting/docs/using-the-solution-reporting-api
      parameters:
      - name: definitionid
        in: path
        required: true
        schema:
          type: string
      - name: reportresultid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/reports/{reportid}:
    delete:
      operationId: delete_api_v1_reports_reportid
      tags:
      - Reports
      summary: Soft-delete a report definition by moving it to ARCHIVED status.
      x-source: https://developer.vertexinc.com/solutionreporting/docs/using-the-solution-reporting-api
      parameters:
      - name: reportid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_api_v1_reports_reportid
      tags:
      - Reports
      summary: Retrieve full metadata for a single report definition
      x-source: https://developer.vertexinc.com/solutionreporting/docs/using-the-solution-reporting-api
      parameters:
      - name: reportid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    put:
      operationId: put_api_v1_reports_reportid
      tags:
      - Reports
      summary: Update an existing saved report definition.
      x-source: https://developer.vertexinc.com/solutionreporting/docs/using-the-solution-reporting-api
      parameters:
      - name: reportid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/reports/{reportid}/results:
    post:
      operationId: post_api_v1_reports_reportid_results
      tags:
      - Reports
      summary: Execute a report definition and create a new report result.
      x-source: https://developer.vertexinc.com/solutionreporting/docs/using-the-solution-reporting-api
      parameters:
      - name: reportid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/reports/{reportid}/schedules:
    delete:
      operationId: delete_api_v1_reports_reportid_schedules
      tags:
      - Reports
      summary: Delete all schedules associated with a specific report definition
      x-source: https://developer.vertexinc.com/solutionreporting/docs/using-the-solution-reporting-api
      parameters:
      - name: reportid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/reports/{reportid}/schedules/{scheduleid}:
    delete:
      operationId: delete_api_v1_reports_reportid_schedules_scheduleid
      tags:
      - Reports
      summary: Delete a specific schedule associated with a given report definition.
      x-source: https://developer.vertexinc.com/solutionreporting/docs/using-the-solution-reporting-api
      parameters:
      - name: reportid
        in: path
        required: true
        schema:
          type: string
      - name: scheduleid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/reports/{reportid}/{id}:
    get:
      operationId: get_api_v1_reports_reportid_id
      tags:
      - Reports
      summary: Retrieve all report results generated for a specific report definition, with…
      x-source: https://developer.vertexinc.com/solutionreporting/docs/using-the-solution-reporting-api
      parameters:
      - name: reportid
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
        collapsed_from: 3 example path(s) differing only at id