Metricool

Metricool Report Api Service API

The Report Api Service API from Metricool — 3 operation(s) for report api service.

GitHub OpenAPI

Operations 5

GET /v2/brands/{blogId}/reports Get list of report history items #
GET /v2/brands/{blogId}/reports/paged Get a paginated list of report history items, most recent first #
GET /v2/brands/{blogId}/reports/{jobId} Get report status #
DELETE /v2/brands/{blogId}/reports/{jobId} Soft-delete a report by id #
PATCH /v2/brands/{blogId}/reports/{jobId} Record the result of executing a report #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/metricool/openapi/metricool-report-api-service-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/metricool/json-schema/metricool-public-blog-schema.json
📊
JSONSchema
https://artifacts.apis.io/metricool/json-schema/metricool-scheduled-post-schema.json
📊
JSONSchema
https://artifacts.apis.io/metricool/json-schema/metricool-ad-campaign-schema.json
📊
JSONSchema
https://artifacts.apis.io/metricool/json-schema/metricool-connected-application-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/metricool/json-schema/metricool-planner-list-schema.json
📊
JSONSchema
https://artifacts.apis.io/metricool/json-schema/metricool-tweet-schema.json

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/metricool:metricool-report-api-service-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.

GitHub Google LinkedIn

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

OpenAPI Specification

metricool-report-api-service-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Metricool Report Api Service API
  description: 'Metricool API


    The base URL for all endpoints is: https://app.metricool.com/api


    All endpoints require authentication.'
  version: 2.0.0
servers:
- url: https://app.metricool.com/api
tags:
- name: Report Api Service
paths:
  /v2/brands/{blogId}/reports:
    get:
      tags:
      - Report Api Service
      summary: Get list of report history items
      description: 'Deprecated: capped at 10 items, no pagination. Use GET .../reports/paged instead. Scheduled for removal once FE migrates.'
      operationId: list_2
      parameters:
      - name: blogId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkListResponseReportHistoryItem'
  /v2/brands/{blogId}/reports/paged:
    get:
      tags:
      - Report Api Service
      summary: Get a paginated list of report history items, most recent first
      operationId: listPaged
      parameters:
      - name: blogId
        in: path
        required: true
        schema:
          type: string
      - name: page
        in: query
        required: true
        schema:
          minimum: 0
          type: integer
          format: int32
      - name: pageSize
        in: query
        required: true
        schema:
          maximum: 100
          minimum: 1
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponsePageDtoReportHistoryItem'
  /v2/brands/{blogId}/reports/{jobId}:
    get:
      tags:
      - Report Api Service
      summary: Get report status
      operationId: getReportStatusInfo
      parameters:
      - name: blogId
        in: path
        required: true
        schema:
          type: string
      - name: jobId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponseReportStatusInfo'
    delete:
      tags:
      - Report Api Service
      summary: Soft-delete a report by id
      operationId: delete_1
      parameters:
      - name: blogId
        in: path
        required: true
        schema:
          type: string
      - name: jobId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponseBoolean'
    patch:
      tags:
      - Report Api Service
      summary: Record the result of executing a report
      operationId: changeStatusNewReport
      parameters:
      - name: blogId
        in: path
        required: true
        schema:
          type: string
      - name: jobId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportStatusInfo'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponseReportStatusInfo'
components:
  schemas:
    JsonOkResponseReportStatusInfo:
      type: object
      properties:
        metadata:
          type: object
        page:
          $ref: '#/components/schemas/JsonPaging'
        data:
          $ref: '#/components/schemas/ReportStatusInfo'
    ReportHistoryItem:
      type: object
      properties:
        id:
          type: integer
          format: int64
        creationDate:
          type: string
          format: date-time
        from:
          type: string
        to:
          type: string
        rss:
          type: boolean
        twitter:
          type: boolean
        facebook:
          type: boolean
        facebookAds:
          type: boolean
        instagram:
          type: boolean
        threads:
          type: boolean
        bluesky:
          type: boolean
        linkedin:
          type: boolean
        pinterest:
          type: boolean
        tiktok:
          type: boolean
        adwords:
          type: boolean
        gmb:
          type: boolean
        youtube:
          type: boolean
        twitch:
          type: boolean
        tiktokAds:
          type: boolean
        brandSummary:
          type: boolean
        reportType:
          type: string
        reportFile:
          type: string
        status:
          type: string
          enum:
          - PENDING
          - RUNNING
          - RETRYING
          - FINISHED
          - FAILED
        engineVersion:
          type: string
    PageDtoReportHistoryItem:
      type: object
      properties:
        elements:
          type: array
          items:
            $ref: '#/components/schemas/ReportHistoryItem'
        pageNumber:
          type: integer
          format: int64
        pageSize:
          type: integer
          format: int32
        totalElements:
          type: integer
          format: int64
    JsonOkResponseBoolean:
      type: object
      properties:
        metadata:
          type: object
        page:
          $ref: '#/components/schemas/JsonPaging'
        data:
          type: boolean
    JsonOkListResponseReportHistoryItem:
      type: object
      properties:
        metadata:
          type: object
        page:
          $ref: '#/components/schemas/JsonPaging'
        data:
          type: array
          items:
            $ref: '#/components/schemas/ReportHistoryItem'
    ReportStatusInfo:
      type: object
      properties:
        status:
          type: string
        reportPath:
          type: string
    JsonPaging:
      type: object
      properties:
        next:
          type: string
    JsonOkResponsePageDtoReportHistoryItem:
      type: object
      properties:
        metadata:
          type: object
        page:
          $ref: '#/components/schemas/JsonPaging'
        data:
          $ref: '#/components/schemas/PageDtoReportHistoryItem'