Admiral Reports API

The reports API from Admiral — 3 operation(s) for reports.

GitHub OpenAPI

Operations 4

POST /accounts/{account_id}/reports Build #
GET /accounts/{account_id}/reports List Reports #
POST /reports/{report_id}/revoke Revoke #
GET /public/reports/{token} Read Public #

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/meetadmiral-com:meetadmiral-com-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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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

OpenAPI Specification

meetadmiral-com-reports-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Admiral Reports API
  version: 0.1.0
tags:
- name: Reports
paths:
  /accounts/{account_id}/reports:
    post:
      tags:
      - Reports
      summary: Build
      operationId: build_accounts__account_id__reports_post
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Account Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Reports
      summary: List Reports
      operationId: list_reports_accounts__account_id__reports_get
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Account Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /reports/{report_id}/revoke:
    post:
      tags:
      - Reports
      summary: Revoke
      description: 'Stop the link working. The row stays, so the report can still say when

        it was revoked rather than 404-ing as if it never existed.'
      operationId: revoke_reports__report_id__revoke_post
      parameters:
      - name: report_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Report Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /public/reports/{token}:
    get:
      tags:
      - Reports
      summary: Read Public
      description: 'The shared link. No auth: the token is the credential.'
      operationId: read_public_public_reports__token__get
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
          title: Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ReportBody:
      properties:
        period_start:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Period Start
        period_end:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Period End
        title:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Title
        agency_name:
          anyOf:
          - type: string
            maxLength: 80
          - type: 'null'
          title: Agency Name
        accent:
          anyOf:
          - type: string
            pattern: ^#[0-9a-fA-F]{6}$
          - type: 'null'
          title: Accent
        footer_note:
          anyOf:
          - type: string
            maxLength: 300
          - type: 'null'
          title: Footer Note
      type: object
      title: ReportBody
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError