experience

Download run artifacts

Deprecated: use experience.run-artifacts.download.v2 (experience_run_artifacts_download_v2), which also names a journey's thumbnail (kind thumbnail); this version answers a thumbnail as the screenshot it previews. Download one media file a journey recorded (a step screenshot, the narration audio, or the shopper's portrait) by its run id and artifact id from experience_journeys_get_v2. Returns the file's name, type and size with a short-lived URL to GET its bytes; call again for a fresh URL.

get/api/v1/experience/run-artifacts/download

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/experience/run-artifacts/download
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Query parameters

runIdstring required

The journey's run id

idstring required

The artifact id the journey's replay names

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Response

Success.

filenamestring required

Suggested file name for saving the bytes

contentTypestring required
byteLengthinteger required
urlstring uri nullable required

Short-lived presigned URL that GETs the bytes; null when this deployment cannot sign the object

expiresAtstring date-time nullable required

When url stops working (minutes after the call); null with url

idstring required

The artifact id

runIdstring required
kind'portrait' | 'screenshot' | 'narration' required

Changes

No recorded changes to this operation across all 1 revision of this API.