API Reference

Get surface content

get
https://content.{region}.api.aampe.com/v1/surface/content

Returns one result per surface that could be resolved, in the same order as requested.
Surfaces that cannot be resolved are omitted from the list.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

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

surface_id
array of uuids
required

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

Surface IDs*
boolean
Defaults to 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.

Responses

401

Invalid or missing X-API-Key, or key could not be validated.

404

None of the requested surfaces could be returned with the current parameters (for example, no content available and fallback disabled).

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?