Codat · Example Payload

Codat Get Commerce Revenue Metrics Example

Unified-API

Codat Get Commerce Revenue Metrics Example is an example object payload from Codat, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

{
  "operationId": "get-commerce-revenue-metrics",
  "method": "GET",
  "path": "/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/revenue",
  "summary": "Get commerce revenue metrics",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": [
        {
          "reportInfo": {
            "name": "revenue",
            "displayName": "Revenue"
          },
          "dimensions": [
            {
              "index": 0,
              "displayName": "Period",
              "type": "datespan",
              "items": [
                {
                  "index": 0,
                  "displayName": "Period 0",
                  "start": "2022-01-01",
                  "end": "2022-12-31"
                }
              ]
            },
            {
              "index": 1,
              "displayName": "Revenue metrics",
              "type": "string",
              "items": [
                {
                  "index": 0,
                  "value": "Revenue"
                },
                {
                  "index": 1,
                  "value": "Revenue growth"
                }
              ]
            }
          ],
          "measures": [
            {
              "displayName": "Value",
              "units": "GBP",
              "index": 0,
              "type": "currency"
            },
            {
              "displayName": "Percentage change vs. previous period",
              "units": "%",
              "index": 1,
              "type": "percentage"
            }
          ],
          "reportData": [
            {
              "dimension": 0,
              "dimensionDisplayName": "Period",
              "item": 0,
              "itemDisplayName": "Period 0",
              "components": [
                {
                  "dimension": 1,
                  "dimensionDisplayName": "Revenue metrics",
                  "item": 0,
                  "itemDisplayName": "Revenue",
                  "measures": [
                    {
                      "index": 0,
                      "measureDisplayName": "Value",
                      "value": 2392.48
                    }
                  ]
                },
                {
                  "dimension": 1,
                  "dimensionDisplayName": "Revenue metrics",
                  "item": 1,
                  "itemDisplayName": "Revenue growth",
                  "measures": [
                    {
                      "index": 1,
                      "measureDisplayName": "Percentage change vs. previous period",
                      "value": 276.65
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Work with this as data

Every example 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 examples

4 MCP tools reach this

find_examplesBrowse and filter every example 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 example

curl "https://apis.io/api/v1/examples/codat-get-commerce-revenue-metrics-example"

All examples

curl "https://apis.io/api/v1/examples?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.