Otter · Schema

GenerateReportMultiRequest

The request to generate a report for multiple stores.

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name	Type	Description
reportType	string	Type of report to generate
start	string	Report start date
end	string	Report end date
externalStoreIds	array	List of external store IDs to filter the orders with. At least one value is required. Max is 5000. Fails the requests if one or more invalid external store ID is passed
externalServiceSlugs	array	List of external service slugs to fetch orders from. Default to all services
language	string	Language of the report. Ignored by ORDER_STORES report Optional. Falls back to English if empty.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "GenerateReportMultiRequest",
  "description": "The request to generate a report for multiple stores.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-generate-report-multi-request-schema.json",
  "type": "object",
  "properties": {
    "reportType": {
      "type": "string",
      "description": "Type of report to generate",
      "example": "ORDER_STORES",
      "enum": [
        "ORDER_STORES",
        "ORDER_ITEMS",
        "PAYOUT_TRANSACTIONS",
        "RATINGS_AND_REVIEWS"
      ]
    },
    "start": {
      "type": "string",
      "description": "Report start date",
      "format": "date",
      "example": "2021-10-01"
    },
    "end": {
      "type": "string",
      "description": "Report end date",
      "format": "date",
      "example": "2021-10-01"
    },
    "externalStoreIds": {
      "type": "array",
      "nullable": false,
      "description": "List of external store IDs to filter the orders with. At least one value is required. Max is 5000. Fails the requests if one or more invalid external store ID is passed",
      "example": [
        "brand1-acbdef",
        "brand1-fghjkl",
        "brand2-qwerty"
      ],
      "items": {
        "type": "string",
        "description": "List of external store IDs to filter the orders with. At least one value is required. Fails the requests if one or more invalid external store ID is passed",
        "example": "[\"brand1-acbdef\", \"brand1-fghjkl\", \"brand2-qwerty\"]"
      }
    },
    "externalServiceSlugs": {
      "type": "array",
      "nullable": true,
      "description": "List of external service slugs to fetch orders from. Default to all services",
      "example": [
        "ubereats",
        "postmates"
      ],
      "items": {
        "type": "string",
        "description": "List of external service slugs to fetch orders from. Default to all services",
        "example": "[\"ubereats\",\"postmates\"]"
      }
    },
    "language": {
      "type": "string",
      "nullable": true,
      "description": "Language of the report. Ignored by ORDER_STORES report Optional. Falls back to English if empty.",
      "example": "string"
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema 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 JSON Schema

curl "https://apis.io/api/v1/json-schemas/public-api-generate-report-multi-request"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.