API docs v1

API reference / 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.

18 endpoints

  1. GET /v1/brands/{brand_id}/audits/{audit_id}/shares List brand-audit shares
  2. POST /v1/brands/{brand_id}/audits/{audit_id}/shares Create a brand-audit share
  3. DELETE /v1/brands/{brand_id}/audits/{audit_id}/shares Revoke brand-audit shares
  4. PATCH /v1/brands/{brand_id}/audits/{audit_id}/shares/{share_id} Extend a brand-audit share
  5. GET /v1/brands/{brand_id}/shares List brand-summary shares
  6. POST /v1/brands/{brand_id}/shares Create a brand-summary share
  7. DELETE /v1/brands/{brand_id}/shares Revoke brand-summary shares
  8. PATCH /v1/brands/{brand_id}/shares/{share_id} Extend a brand-summary share
  9. GET /v1/reports/{report_id}/shares List shares
  10. POST /v1/reports/{report_id}/shares Create a share
  11. DELETE /v1/reports/{report_id}/shares Revoke shares
  12. PATCH /v1/reports/{report_id}/shares/{share_id} Extend a share
  13. GET /v1/scheduled-reports/{scheduled_report_id}/shares List scheduled-report shares
  14. POST /v1/scheduled-reports/{scheduled_report_id}/shares Create a scheduled-report share
  15. DELETE /v1/scheduled-reports/{scheduled_report_id}/shares Revoke scheduled-report shares
  16. PATCH /v1/scheduled-reports/{scheduled_report_id}/shares/{share_id} Extend a scheduled-report share
  17. GET /v1/shares List the account's shares
  18. DELETE /v1/shares/{share_id} Revoke a share