Skip to main content

Associate and look up sessions

Ramon's embed accepts sessionId and interviewId UUIDs. Store a single platform response UUID and pass it as both values unless you have a clear reason to use separate identifiers. Ramon can then find a summary by session ID or external reference.

curl --request POST \
"https://api.getramon.com/integrations/v1/surveys/YOUR_SURVEY_ID/sessions/lookup" \
--header "Authorization: Bearer YOUR_INTEGRATION_KEY" \
--header "Content-Type: application/json" \
--data '{"externalReferences":["11111111-1111-4111-8111-111111111111"]}'

Submit one to 100 UUID externalReferences. Ramon preserves the input order and returns a row for every reference, including references not yet captured.

{
"data": [{
"externalReference": "11111111-1111-4111-8111-111111111111",
"captured": true,
"eventCount": 42,
"firstEventAt": "2026-07-25T10:00:00.000Z",
"lastEventAt": "2026-07-25T10:03:00.000Z",
"humanScorePercent": null,
"scoreBand": null,
"scoredAt": null,
"modelVersion": null
}]
}

The response contains summary-level information only; event-level behavioral data is not returned by this API.