Studio Api Service

Create a new Studio report from a contextual shortcut

post/v2/reporting/studio/reports/shortcuts

Request

  • Base URL: https://app.metricool.com/api
  • URL: https://app.metricool.com/api/v2/reporting/studio/reports/shortcuts
  • Auth: none declared

Request body

templateTypestring required

Identifier of the shortcut template to apply

networkstring required

Social network the shortcut targets

brandIdsstring[] required

Brand (blog) identifiers the shortcut report covers

tableNamestring

Source table the insight is built from. Required for the 'table-insights' template; unused for 'compare-periods'.

questionstring

Predefined question the insight answers. Required for the 'table-insights' template; unused for 'compare-periods'.

sortDirectionstring

Ranking direction ('asc' or 'desc') for the table-insights topContent chart, overriding the template's default. Unused for 'compare-periods'.

promptstring required

User prompt saved for refresh

Example request

{
  "templateType": "compare-periods",
  "network": "instagram",
  "brandIds": [
    "12345"
  ],
  "mainPeriod": {
    "from": "2025-07-01",
    "to": "2025-07-31"
  },
  "comparisonPeriod": {
    "from": "2025-07-01",
    "to": "2025-07-31"
  },
  "tableName": "posts",
  "question": "What are my best performing posts and why?",
  "sortDirection": "asc",
  "prompt": "Focus on engagement metrics and compare growth trends"
}

Response

OK

metadataobject

Example response

{
  "data": {
    "id": "25674c14-a879-4e1f-8fd7-c09243a10726",
    "status": "COMPLETED",
    "errorType": "TIMEOUT",
    "studioId": "25674c14-a879-4e1f-8fd7-c09243a10726",
    "name": "Line chart during may 2025",
    "type": "Calendar",
    "period": "01-Feb-2026 - 28-Feb-2026",
    "networks": [
      "facebook",
      "instagram"
    ],
    "brands": [
      {
        "blogId": 123456,
        "name": "My Brand",
        "logo": "https://example.com/logo.png"
      }
    ],
    "totalVersions": 3,
    "customLogoUrl": "https://metricool-download.s3.eu-west-1.amazonaws.com/studio-logo/12345/202605/abc123def456.png",
    "sharedLink": "https://app.metricool.com/c/abc123",
    "selected": true,
    "hasManualEdits": true,
    "totalAgents": 5,
    "failedAgents": 1,
    "failedAgentDetails": [
      {
        "taskIndex": 2,
        "agentName": "engagement-agent",
        "errorType": "TIMEOUT"
      }
    ],
    "shownVersionState": "LATEST"
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.