Initializing Operalta...

Operalta

Reports

Generate reports, freeze versions, and export decks.

GET
/api/reports

Authorization

BearerAuth
AuthorizationBearer <token>

API key obtained from Operalta Settings → API Keys. Format: op_xxxxx. Pass as Authorization: Bearer op_....

In: header

Query Parameters

companyId*string

UUID of the company. Alternatively, pass as X-Company-Id request header.

Formatuuid

Header Parameters

X-Company-Id?string

Company UUID. Alternative to the companyId query parameter.

Formatuuid

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/reports?companyId=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "reports": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "title": "string",
      "template_id": "string",
      "date_range_start": "2019-08-24",
      "date_range_end": "2019-08-24",
      "date_preset": "string",
      "generation_time_ms": 0,
      "total_entries": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
      "report_json": {
        "summary": {}
      },
      "markdown_summary": "string",
      "status": "queued",
      "annotations_enabled": true
    }
  ]
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
POST
/api/reports

Authorization

BearerAuth
AuthorizationBearer <token>

API key obtained from Operalta Settings → API Keys. Format: op_xxxxx. Pass as Authorization: Bearer op_....

In: header

Header Parameters

X-Company-Id?string

Company UUID. Alternative to the companyId query parameter.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/reports" \  -H "Content-Type: application/json" \  -d '{    "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",    "title": "string",    "templateId": "string",    "reportJson": {}  }'
{
  "report": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
    "title": "string",
    "template_id": "string",
    "markdown": "string",
    "markdown_bundle": {
      "property1": "string",
      "property2": "string"
    },
    "report_json": {},
    "date_range_start": "2019-08-24",
    "date_range_end": "2019-08-24",
    "date_preset": "string",
    "generation_time_ms": 0,
    "total_entries": 0,
    "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "status": "queued",
    "edited_markdown": "string",
    "edited_at": "2019-08-24T14:15:22Z",
    "edited_by": "9501acb5-3be0-4719-a60e-dfa79624666c",
    "last_autosave_at": "2019-08-24T14:15:22Z",
    "variant": "summary",
    "markdown_summary": "string",
    "markdown_executive": "string",
    "markdown_detailed": "string",
    "annotations_enabled": true,
    "memorized_at": "2019-08-24T14:15:22Z",
    "sent_at": "2019-08-24T14:15:22Z",
    "error_message": "string",
    "source_type": "string",
    "source_attachment_id": "018cc987-22d3-4010-9bab-670e3bdf02d2",
    "parent_report_id": "a1fe59df-675f-4954-83a3-075d2e86d697",
    "child_report_ids": [
      "f804eb3c-6e70-45c4-8869-9337f33cdf5c"
    ],
    "rollup_summary": "string",
    "content": "string",
    "metadata": {},
    "source_entry_ids": [
      "b7da7ee7-d49e-420d-be1e-f902a2c3a013"
    ],
    "source_query": {},
    "company": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string",
      "vertical": "string"
    }
  }
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
PATCH
/api/reports

Authorization

BearerAuth
AuthorizationBearer <token>

API key obtained from Operalta Settings → API Keys. Format: op_xxxxx. Pass as Authorization: Bearer op_....

In: header

Header Parameters

X-Company-Id?string

Company UUID. Alternative to the companyId query parameter.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/reports" \  -H "Content-Type: application/json" \  -d '{    "reportId": "836df459-dc40-4aa1-972a-6eb0a864dff9",    "editedMarkdown": "string",    "variant": "summary"  }'
{
  "success": true,
  "report": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
    "title": "string",
    "template_id": "string",
    "markdown": "string",
    "markdown_bundle": {
      "property1": "string",
      "property2": "string"
    },
    "report_json": {},
    "date_range_start": "2019-08-24",
    "date_range_end": "2019-08-24",
    "date_preset": "string",
    "generation_time_ms": 0,
    "total_entries": 0,
    "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "status": "queued",
    "edited_markdown": "string",
    "edited_at": "2019-08-24T14:15:22Z",
    "edited_by": "9501acb5-3be0-4719-a60e-dfa79624666c",
    "last_autosave_at": "2019-08-24T14:15:22Z",
    "variant": "summary",
    "markdown_summary": "string",
    "markdown_executive": "string",
    "markdown_detailed": "string",
    "annotations_enabled": true,
    "memorized_at": "2019-08-24T14:15:22Z",
    "sent_at": "2019-08-24T14:15:22Z",
    "error_message": "string",
    "source_type": "string",
    "source_attachment_id": "018cc987-22d3-4010-9bab-670e3bdf02d2",
    "parent_report_id": "a1fe59df-675f-4954-83a3-075d2e86d697",
    "child_report_ids": [
      "f804eb3c-6e70-45c4-8869-9337f33cdf5c"
    ],
    "rollup_summary": "string",
    "content": "string",
    "metadata": {},
    "source_entry_ids": [
      "b7da7ee7-d49e-420d-be1e-f902a2c3a013"
    ],
    "source_query": {},
    "company": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string",
      "vertical": "string"
    }
  },
  "version": 0
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
GET
/api/reports/{id}

Authorization

BearerAuth
AuthorizationBearer <token>

API key obtained from Operalta Settings → API Keys. Format: op_xxxxx. Pass as Authorization: Bearer op_....

In: header

Path Parameters

id*string
Formatuuid

Header Parameters

X-Company-Id?string

Company UUID. Alternative to the companyId query parameter.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/reports/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "report": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
    "title": "string",
    "template_id": "string",
    "markdown": "string",
    "markdown_bundle": {
      "property1": "string",
      "property2": "string"
    },
    "report_json": {},
    "date_range_start": "2019-08-24",
    "date_range_end": "2019-08-24",
    "date_preset": "string",
    "generation_time_ms": 0,
    "total_entries": 0,
    "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "status": "queued",
    "edited_markdown": "string",
    "edited_at": "2019-08-24T14:15:22Z",
    "edited_by": "9501acb5-3be0-4719-a60e-dfa79624666c",
    "last_autosave_at": "2019-08-24T14:15:22Z",
    "variant": "summary",
    "markdown_summary": "string",
    "markdown_executive": "string",
    "markdown_detailed": "string",
    "annotations_enabled": true,
    "memorized_at": "2019-08-24T14:15:22Z",
    "sent_at": "2019-08-24T14:15:22Z",
    "error_message": "string",
    "source_type": "string",
    "source_attachment_id": "018cc987-22d3-4010-9bab-670e3bdf02d2",
    "parent_report_id": "a1fe59df-675f-4954-83a3-075d2e86d697",
    "child_report_ids": [
      "f804eb3c-6e70-45c4-8869-9337f33cdf5c"
    ],
    "rollup_summary": "string",
    "content": "string",
    "metadata": {},
    "source_entry_ids": [
      "b7da7ee7-d49e-420d-be1e-f902a2c3a013"
    ],
    "source_query": {},
    "company": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string",
      "vertical": "string"
    }
  }
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
DELETE
/api/reports/{id}

Authorization

BearerAuth
AuthorizationBearer <token>

API key obtained from Operalta Settings → API Keys. Format: op_xxxxx. Pass as Authorization: Bearer op_....

In: header

Path Parameters

id*string
Formatuuid

Header Parameters

X-Company-Id?string

Company UUID. Alternative to the companyId query parameter.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/reports/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "success": true
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
POST
/api/reports/{id}/autosave

Authorization

BearerAuth
AuthorizationBearer <token>

API key obtained from Operalta Settings → API Keys. Format: op_xxxxx. Pass as Authorization: Bearer op_....

In: header

Path Parameters

id*string
Formatuuid

Header Parameters

X-Company-Id?string

Company UUID. Alternative to the companyId query parameter.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/reports/497f6eca-6276-4993-bfeb-53cbbbba6f08/autosave" \  -H "Content-Type: application/json" \  -d '{    "editedMarkdown": "string",    "variant": "summary"  }'
{
  "success": true,
  "autosavedAt": "2019-08-24T14:15:22Z",
  "versionCreated": true
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
GET
/api/reports/{id}/metrics

Authorization

SessionCookie
Cookie<token>

Authenticated Operalta web session Cookie header. In practice this usually contains sb-<project-ref>-auth-token=... and may include chunked siblings; use the full Cookie header copied from a logged-in browser session.

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/reports/497f6eca-6276-4993-bfeb-53cbbbba6f08/metrics"
{
  "metrics": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "report_id": "5ed7905a-4735-4cf7-b1ab-521e066fb971",
      "metric_id": "string",
      "metric_source": "datapack",
      "company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
      "stage": "string",
      "vertical": "string",
      "value": 0,
      "formatted_value": "string",
      "status": "green",
      "benchmark_target": "string",
      "previous_value": 0,
      "delta_percent": 0,
      "benchmark_percentile": 0,
      "source_period_key": "string",
      "calculation_params": {},
      "captured_at": "2019-08-24T14:15:22Z"
    }
  ],
  "source": "report_metric_snapshots",
  "missingSnapshots": true
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
POST
/api/reports/{id}/publish

Authorization

BearerAuth
AuthorizationBearer <token>

API key obtained from Operalta Settings → API Keys. Format: op_xxxxx. Pass as Authorization: Bearer op_....

In: header

Path Parameters

id*string
Formatuuid

Header Parameters

X-Company-Id?string

Company UUID. Alternative to the companyId query parameter.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/reports/497f6eca-6276-4993-bfeb-53cbbbba6f08/publish"
{
  "success": true,
  "report": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
    "title": "string",
    "template_id": "string",
    "markdown": "string",
    "markdown_bundle": {
      "property1": "string",
      "property2": "string"
    },
    "report_json": {},
    "date_range_start": "2019-08-24",
    "date_range_end": "2019-08-24",
    "date_preset": "string",
    "generation_time_ms": 0,
    "total_entries": 0,
    "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "status": "queued",
    "edited_markdown": "string",
    "edited_at": "2019-08-24T14:15:22Z",
    "edited_by": "9501acb5-3be0-4719-a60e-dfa79624666c",
    "last_autosave_at": "2019-08-24T14:15:22Z",
    "variant": "summary",
    "markdown_summary": "string",
    "markdown_executive": "string",
    "markdown_detailed": "string",
    "annotations_enabled": true,
    "memorized_at": "2019-08-24T14:15:22Z",
    "sent_at": "2019-08-24T14:15:22Z",
    "error_message": "string",
    "source_type": "string",
    "source_attachment_id": "018cc987-22d3-4010-9bab-670e3bdf02d2",
    "parent_report_id": "a1fe59df-675f-4954-83a3-075d2e86d697",
    "child_report_ids": [
      "f804eb3c-6e70-45c4-8869-9337f33cdf5c"
    ],
    "rollup_summary": "string",
    "content": "string",
    "metadata": {},
    "source_entry_ids": [
      "b7da7ee7-d49e-420d-be1e-f902a2c3a013"
    ],
    "source_query": {},
    "company": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string",
      "vertical": "string"
    }
  },
  "memorizeQueued": true,
  "memorizeJobId": "string",
  "warning": "string"
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
POST
/api/reports/{id}/send

Authorization

BearerAuth
AuthorizationBearer <token>

API key obtained from Operalta Settings → API Keys. Format: op_xxxxx. Pass as Authorization: Bearer op_....

In: header

Path Parameters

id*string
Formatuuid

Header Parameters

X-Company-Id?string

Company UUID. Alternative to the companyId query parameter.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/reports/497f6eca-6276-4993-bfeb-53cbbbba6f08/send" \  -H "Content-Type: application/json" \  -d '{}'
{
  "success": true,
  "sendId": "98079182-77f0-4075-97da-b6e925fc22cb",
  "shareUrl": "http://example.com",
  "periodKey": "string",
  "periodLabel": "string",
  "versionNumber": 0,
  "recipients": [
    "user@example.com"
  ],
  "recipientCount": 0,
  "mode": "audience",
  "viewerPolicy": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
GET
/api/reports/{id}/versions

Authorization

BearerAuth
AuthorizationBearer <token>

API key obtained from Operalta Settings → API Keys. Format: op_xxxxx. Pass as Authorization: Bearer op_....

In: header

Path Parameters

id*string
Formatuuid

Header Parameters

X-Company-Id?string

Company UUID. Alternative to the companyId query parameter.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/reports/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions"
{
  "versions": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "report_id": "5ed7905a-4735-4cf7-b1ab-521e066fb971",
      "markdown": "string",
      "variant": "summary",
      "version_number": 0,
      "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
      "created_at": "2019-08-24T14:15:22Z",
      "change_description": "string",
      "created_by_profile": {
        "name": "string",
        "email": "user@example.com"
      }
    }
  ],
  "total": 0
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
POST
/api/reports/{id}/versions

Authorization

BearerAuth
AuthorizationBearer <token>

API key obtained from Operalta Settings → API Keys. Format: op_xxxxx. Pass as Authorization: Bearer op_....

In: header

Path Parameters

id*string
Formatuuid

Header Parameters

X-Company-Id?string

Company UUID. Alternative to the companyId query parameter.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

versionNumber*integer

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/reports/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions" \  -H "Content-Type: application/json" \  -d '{    "versionNumber": 0  }'
{
  "success": true,
  "report": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
    "title": "string",
    "template_id": "string",
    "markdown": "string",
    "markdown_bundle": {
      "property1": "string",
      "property2": "string"
    },
    "report_json": {},
    "date_range_start": "2019-08-24",
    "date_range_end": "2019-08-24",
    "date_preset": "string",
    "generation_time_ms": 0,
    "total_entries": 0,
    "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "status": "queued",
    "edited_markdown": "string",
    "edited_at": "2019-08-24T14:15:22Z",
    "edited_by": "9501acb5-3be0-4719-a60e-dfa79624666c",
    "last_autosave_at": "2019-08-24T14:15:22Z",
    "variant": "summary",
    "markdown_summary": "string",
    "markdown_executive": "string",
    "markdown_detailed": "string",
    "annotations_enabled": true,
    "memorized_at": "2019-08-24T14:15:22Z",
    "sent_at": "2019-08-24T14:15:22Z",
    "error_message": "string",
    "source_type": "string",
    "source_attachment_id": "018cc987-22d3-4010-9bab-670e3bdf02d2",
    "parent_report_id": "a1fe59df-675f-4954-83a3-075d2e86d697",
    "child_report_ids": [
      "f804eb3c-6e70-45c4-8869-9337f33cdf5c"
    ],
    "rollup_summary": "string",
    "content": "string",
    "metadata": {},
    "source_entry_ids": [
      "b7da7ee7-d49e-420d-be1e-f902a2c3a013"
    ],
    "source_query": {},
    "company": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string",
      "vertical": "string"
    }
  },
  "restoredFromVersion": 0
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
GET
/api/reports/public/{slug}/{period}/{version}/{token}

Path Parameters

slug*string

Company slug embedded in the public share URL.

period*string

Published period key for the shared report.

version*string

Published version segment, for example v1 or v2.

Match^v\d+$
token*string

Opaque public share token.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/reports/public/string/string/string/string"
{
  "success": true,
  "report": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "title": "string",
    "markdown": "string",
    "templateId": "string",
    "datePreset": "string",
    "dateRangeStart": "string",
    "dateRangeEnd": "string",
    "totalEntries": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "company": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string"
    }
  },
  "send": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "sentAt": "2019-08-24T14:15:22Z",
    "isCorrection": true,
    "status": "string",
    "periodKey": "string",
    "versionNumber": 0,
    "viewerPolicy": {}
  },
  "meta": {
    "periodLabel": "string",
    "isSuperseded": true,
    "nextVersionUrl": "string"
  }
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
GET
/api/reports/public/typed/{type}/{slug}/{period}/{version}/{token}

Path Parameters

type*string

Typed URL prefix such as board-reports, monthly-updates, or lp-reports.

slug*string

Company slug embedded in the public share URL.

period*string

Published period key for the shared report.

version*string

Published version segment, for example v1 or v2.

Match^v\d+$
token*string

Opaque public share token.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/reports/public/typed/string/string/string/string/string"
{
  "success": true,
  "report": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "title": "string",
    "markdown": "string",
    "templateId": "string",
    "datePreset": "string",
    "dateRangeStart": "string",
    "dateRangeEnd": "string",
    "totalEntries": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "company": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string"
    }
  },
  "send": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "sentAt": "2019-08-24T14:15:22Z",
    "isCorrection": true,
    "status": "string",
    "periodKey": "string",
    "versionNumber": 0,
    "viewerPolicy": {}
  },
  "meta": {
    "periodLabel": "string",
    "reportTypeLabel": "string",
    "isSuperseded": true,
    "nextVersionUrl": "string"
  }
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
POST
/api/reports/share

Authorization

BearerAuth
AuthorizationBearer <token>

API key obtained from Operalta Settings → API Keys. Format: op_xxxxx. Pass as Authorization: Bearer op_....

In: header

Header Parameters

X-Company-Id?string

Company UUID. Alternative to the companyId query parameter.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/reports/share" \  -H "Content-Type: application/json" \  -d '{    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"  }'
{
  "success": true,
  "revoked": true,
  "token": "string",
  "url": "http://example.com",
  "viewerPolicy": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}
{
  "error": "string",
  "status": 0,
  "details": {}
}