Skip to main content
GET
/
v1
/
surface
/
content
Get surface content
curl --request GET \
  --url https://content.{region}.api.aampe.com/v1/surface/content \
  --header 'X-API-Key: <api-key>'
[
  {
    "surface_id": "c40b13ac-3c46-4537-b205-78ce7426ce2a",
    "assignment_id": "34889d49-6d13-47af-8db5-c12ce4d8b5f2",
    "n_alternates": 1,
    "control": {
      "min_gap_days": 1
    },
    "alternates": [
      {
        "alternate_assignment_id": "b7697880-8fbc-42b9-a410-cb46e35133ee"
      }
    ]
  }
]

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:

"c40b13ac-3c46-4537-b205-78ce7426ce2a"

​
assignment_id
string<uuid>
required

Identifier for this content assignment in the response.

Example:

"34889d49-6d13-47af-8db5-c12ce4d8b5f2"

​
n_alternates
integer
required

Total number of alternates.

Example:

1

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