Results

Generate shareable link for a combined report

Changed on

Generate a link that opens the combined report for the given results without authentication. Anyone holding the link can read those results, so treat it as public. Set expire_at to bound how long it stays readable.

post/test_framework/v2/results/reports/share/

Request

  • Base URL
    https://api.cekura.ai
  • URL
    https://api.cekura.ai/test_framework/v2/results/reports/share/
  • Auth
    • API key in header X-CEKURA-API-KEY
    • or HTTP bearer
    • or HTTP bearer
    • or API key in header X-VOCERA-SHAREABLE-LINK-TOKEN
    • or HTTP bearer

Request body

result_idsinteger[] required

Result IDs the link should cover. The link exposes exactly these results.

expire_atstring date-time nullable

Optional expiration date/time for the token (ISO 8601 format). Omit for a link that never expires.

passwordstring nullable

Optional password, 6 to 128 characters. Viewers must enter it before the shared results load.

Response

tokenstring required

Unique token identifier for the shareable link, used for authentication and access control

shareable_linkstring required

Complete URL for the shareable link that can be distributed to external users

is_password_protectedboolean required

Whether viewers must enter a password to open the link

Changes