experience

Download run artifacts (v3)

Download one media file a journey recorded (a step screenshot, the journey's thumbnail or small thumbnail, the narration audio, or the shopper's portrait) by its run id and artifact id: a replay frame from experience_journeys_get_v3, a journey's recording.thumbnailArtifactId from experience_journeys_list_v5 (its small thumbnail), or from experience_campaign_overview_get_v7's replayJourneys or experience_campaign_analytics_get_v9's panels (its thumbnail). 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-v3

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/experience/run-artifacts/download-v3
  • 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' | 'thumbnail' | 'small_thumbnail' required

Changes

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