Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Updates an analytics record for a specific user input. Allows modifying conversation properties, Flow and Intent details, ratings, handover information, Slots, tracked goals, and custom fields.
curl --request PATCH \
--url https://api-trial.cognigy.ai/new/v2.0/analytics \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"contactId": "contactId",
"projectId": "projectId",
"sessionId": "sessionId",
"inputId": "inputId",
"properties": {
"state": "state",
"mode": "mode",
"userType": "user userType",
"channel": "channel",
"flowLanguage": "new flowLanguage",
"intent": "new intent",
"intentFlow": "new intentFlow",
"intentScore": 0,
"flowName": "new flowName",
"inHandoverRequest": false,
"inHandoverConversation": false,
"localeName": "new localeName",
"rating": 9,
"ratingComment": "new ratingComment",
"entrypointType": "new entrypointType",
"endpointName": "new endpointName",
"endpointUrlToken": "new endpointUrlToken",
"handoverEscalations": 2,
"snapshotName": "new snapshotName",
"slots": "new slots",
"custom1": "new custom1",
"custom2": "new custom2",
"custom3": "new custom3",
"custom4": "new custom4",
"custom5": "new custom5",
"custom6": "new custom6",
"custom7": "new custom7",
"custom8": "new custom8",
"custom9": "new custom9",
"custom10": "new custom10"
}
}
'{
"type": "Bad Request",
"title": "Bad Request Error",
"status": 400,
"detail": "Validation failed. Missing payload.",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}Documentation Index
Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt
Use this file to discover all available pages before exploring further.
Supply the API Key in the HTTP-Header
The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.
application/json, application/hal+json, application/xml, text/xml, text/csv Successfully updated the Analytics Record
curl --request PATCH \
--url https://api-trial.cognigy.ai/new/v2.0/analytics \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"contactId": "contactId",
"projectId": "projectId",
"sessionId": "sessionId",
"inputId": "inputId",
"properties": {
"state": "state",
"mode": "mode",
"userType": "user userType",
"channel": "channel",
"flowLanguage": "new flowLanguage",
"intent": "new intent",
"intentFlow": "new intentFlow",
"intentScore": 0,
"flowName": "new flowName",
"inHandoverRequest": false,
"inHandoverConversation": false,
"localeName": "new localeName",
"rating": 9,
"ratingComment": "new ratingComment",
"entrypointType": "new entrypointType",
"endpointName": "new endpointName",
"endpointUrlToken": "new endpointUrlToken",
"handoverEscalations": 2,
"snapshotName": "new snapshotName",
"slots": "new slots",
"custom1": "new custom1",
"custom2": "new custom2",
"custom3": "new custom3",
"custom4": "new custom4",
"custom5": "new custom5",
"custom6": "new custom6",
"custom7": "new custom7",
"custom8": "new custom8",
"custom9": "new custom9",
"custom10": "new custom10"
}
}
'{
"type": "Bad Request",
"title": "Bad Request Error",
"status": 400,
"detail": "Validation failed. Missing payload.",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}