Overview

Use this endpoint to:

• Check whether a snapshot generation job has completed
• Retrieve the generated file URL when the snapshot is ready
• Identify failed or expired snapshot jobs

This endpoint does not create new snapshots or return the report file itself.

Availability

Supported for Onsite Display and Offsite Display (Walmart DSP) Performance and Entity Snapshots.

How it works

After creating a snapshot, use the returned snapshotId to check processing status. When jobStatus=done, the API returns the generated file URL in details.

Before you begin

• Valid advertiserId
• Valid snapshotId returned by a Performance or Entity Snapshot creation request
• Reporting read access for the advertiser account

Endpoint

GET /api/v1/snapshot

View technical specifications

Request details

How this request is used

Use this endpoint to retrieve the current processing status of a previously submitted snapshot job.

The same endpoint supports both Performance and Entity Snapshots.

Key fields and behaviors

• snapshotId
  Identifies the snapshot job created by POST /api/v1/snapshot/report or POST /api/v1/snapshot/entity

Important behavior

• The endpoint retrieves an existing snapshot job; it does not initiate processing.
• The snapshotId must correspond to a snapshot created for the specified advertiser.
• Snapshot processing is asynchronous. Multiple status requests may be needed before the file is ready.
• When jobStatus=done, the details field contains the generated file URL.

Sample request

curl -X GET \ 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/snapshot?advertiserId=600001&snapshotId=123abb56-92g1-2123-ce89-192decd37b7' \ --header 'Authorization: Bearer <auth_token>' \ --header 'WM_SEC.AUTH_SIGNATURE: <signature>' \ --header 'WM_SEC.KEY_VERSION: 1' \ --header 'WM_CONSUMER.ID: <consumer_id>' \ --header 'WM_CONSUMER.intimestamp: <timestamp>' \ --header 'Accept: application/json'

Response details

What this response returns

The response provides the current status of the snapshot generation job and, when processing is complete, the URL used to download the generated file.

Key fields to use

• code
  Indicates whether the retrieval request suceeeded.
• snapshotId
  Indicates the snapshot job being retrieved.
• jobStatus
  Current processing status
• details
  Returns the generated file URL when jobStatus=done.

How to interpret jobStatus

Use jobStatus to determine the next action for the snapshot.

Sample responses

{ "code": "success", "snapshotId": "123abb56-92g1-2123-ce89-192decd37b7", "details": "", "jobStatus": "pending"
}

{ "code": "success", "snapshotId": "123abb56-92g1-2123-ce89-192decd37b7", "details": "https://advertising.walmart.com/stage/display/file/721acd56-51g2-2123-de88-171bedd37a2", "jobStatus": "done"
}

Downloading snapshot files

Once the snapshot job is complete, download the generated file using the URL returned in details.

Both Performance and Entity Snapshot downloads require authentication.

Download requirements

The file download URL follows this structure:

GET https://advertising.walmart.com/stage/display/file/{fileId}?advertiserId={advertiserId}

Use the file URL returned by the API rather than constructing a new file identifier.

File format and expiration

Best practice

For automated reporting pipelines, confirm the latest available report date before creating Performance Snapshots. Store the returned snapshotId, check processing status until completion, and download generated files promptly to avoid expiration.

Common issues

• Using an incorrect snapshotId or advertiserId
• Assuming a successful creation request means the snapshot file is ready
• Attempting to download before jobStatus=done
• Expecting the response to contain report data rather than a file URL
• Failing to retrieve the download URL from details
• Attempting to retrieve a file after its availability window has expired

What happens next

When jobStatus=done, use the file URL returned in details to download the snapshot.

Generated files are available for 24 hours after generation. Download and store the file before it expires.

For download authentication requirements and file handling guidance, see Snapshot Reporting.

Related pages

• Snapshot Reporting
• Create Performance Snapshot
• Create Entity Snapshot
• Reporting API Overview