API docs v1

Resource

Shares

Time-limited public share links for reports, scheduled reports, brand summaries and brand audits. Each share is a read-only snapshot resolved at /shared/{access_token}. POST is idempotent; pass rotate=true to invalidate a leaked URL.

Operations

Method Endpoint Summary
GET /v1/brands/{brand_id}/audits/{audit_id}/shares List brand-audit shares
POST /v1/brands/{brand_id}/audits/{audit_id}/shares Create a brand-audit share
DELETE /v1/brands/{brand_id}/audits/{audit_id}/shares Revoke brand-audit shares
PATCH /v1/brands/{brand_id}/audits/{audit_id}/shares/{share_id} Extend a brand-audit share
GET /v1/brands/{brand_id}/shares List brand-summary shares
POST /v1/brands/{brand_id}/shares Create a brand-summary share
DELETE /v1/brands/{brand_id}/shares Revoke brand-summary shares
PATCH /v1/brands/{brand_id}/shares/{share_id} Extend a brand-summary share
GET /v1/reports/{report_id}/shares List shares
POST /v1/reports/{report_id}/shares Create a share
DELETE /v1/reports/{report_id}/shares Revoke shares
PATCH /v1/reports/{report_id}/shares/{share_id} Extend a share
GET /v1/scheduled-reports/{scheduled_report_id}/shares List scheduled-report shares
POST /v1/scheduled-reports/{scheduled_report_id}/shares Create a scheduled-report share
DELETE /v1/scheduled-reports/{scheduled_report_id}/shares Revoke scheduled-report shares
PATCH /v1/scheduled-reports/{scheduled_report_id}/shares/{share_id} Extend a scheduled-report share