Otter · JSON Structure

Public Api Generate Report Multi Request Structure

The request to generate a report for multiple stores.

Type: object Properties: 6
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

GenerateReportMultiRequest is a JSON Structure definition published by Otter, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

reportType start end externalStoreIds externalServiceSlugs language

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-structure/public-api-generate-report-multi-request-structure.json",
  "name": "GenerateReportMultiRequest",
  "description": "The request to generate a report for multiple stores.",
  "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": "date",
      "description": "Report start date",
      "example": "2021-10-01"
    },
    "end": {
      "type": "date",
      "description": "Report end 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 Structure 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 json structure

4 MCP tools reach this
  • find_json_structuresBrowse and filter every JSON Structure 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 Structure
curl "https://apis.io/api/v1/json-structures/public-api-generate-report-multi-request-structure"
All json structure
curl "https://apis.io/api/v1/json-structures?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.

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