Skip to main content
GET
Get surface content

Authorizations

X-API-Key
string
header
required

Query Parameters

contact_id
string
required

The ID of the user for which you want to retrieve content.

surface_id
string<uuid>[]
required

The UUID v4 IDs of the surfaces for which you want to retrieve content.

allow_unassigned
boolean
default:false

When true, surfaces without personalized content for this user may still return a default variant from Aampe. When false, those surfaces are skipped; the API returns 404 if no requested surface can be returned.

Response

Successful Response

surface_id
string<uuid>
required

UUID v4 id for the surface

Example:

"eb223fbc-9065-4ff0-ae2a-c47c623bff07"

assignment_id
string<uuid>
required

Identifier for this content assignment in the response.

Example:

"2ceb1da8-b6f7-4089-b55d-5ba743389cea"

n_alternates
integer
required

Total number of alternates.

Example:

1

control
SurfaceControl · object
required
alternates
SurfaceAlternate · object[]
required