reports.read

Input JSON Schema

This schema is generated from the canonical Zod input schema in the shared contract package, not copied into the docs source. JSON Schema describes representable structure; runtime refinements and transforms remain enforced by the canonical parser and may not be fully represented here.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "idea",
        "bmc",
        "marketing"
      ]
    },
    "id": {
      "type": "string",
      "pattern": "^(?:[1-9]\\d{0,17}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"
    },
    "report_access_token": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512
    }
  },
  "required": [
    "kind",
    "id",
    "report_access_token"
  ],
  "additionalProperties": false
}

HTTP and CLI

POST the versioned operation envelope to /api/v2/execute. Replace the placeholder with a valid input object from the schema above; this shape is not a runnable request.

{"version":1,"operation":"reports.read","input":<input-object matching schema>}

CLI command shape: indielogs call reports.read '<input-json>'. The placeholder is not a valid sample input.