curl --request POST \
  --url https://api.sandbox.asapp.com/autocompose/v1/conversations/{conversationId}/message-analytic-events \
  --header 'Content-Type: application/json' \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>' \
  --data '
{
  "type": "suggestion-1-inserted",
  "suggestionsId": "4d2fd982640c311394008259594399a1"
}
'

This response has no body data.

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "400-01",
    "message": "Bad request"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "401-01",
    "message": "Unauthorized"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "403-01",
    "message": "Forbidden Response"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "404-01",
    "message": "Not Found"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "409-01",
    "message": "Conflict"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "413-01",
    "message": "Request Entity Too Large"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "422-01",
    "message": "Unprocessable Entity"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "429-01",
    "message": "Too Many Requests"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "503-01",
    "message": "Service Unavailable"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "500-01",
    "message": "Internal server error"
  }
}

Conversation Suggestions

Create a message analytic event

To improve the performance of ASAPP suggestions, provide information about the actions performed by the agent while composing a message by creating message-analytic-events.

These analytic events indicate which AutoCompose functionality was used or not. This information along with the conversation itself is used to optimize our models, resulting in better results for the agents.

We track the following types of message analytic events:

suggestion-1-inserted: The agent selected the first of the suggestions from a Suggestion API response.
suggestion-2-inserted: The agent selected the second of the suggestions from a Suggestion API response.
suggestion-3-inserted: The agent selected the third of the suggestions from a Suggestion API response.
phrase-completion-accepted: The agent selected the phraseCompletion from a Suggestion API response.
spellcheck-applied: A correction provided in a SpellcheckCorrection API response was applied automatically.
spellcheck-undone: A correction provided in a SpellcheckCorrection API response was undone by clicking the undo button.
custom-response-drawer-inserted: The agent inserted one of their custom responses from the custom response drawer.
custom-panel-inserted: The agent inserted a response from their custom response list in the custom response panel.
global-panel-inserted: The agent inserted a response from the global response list in the global response panel.

Some of the event types have a corresponding event object to provide details.

POST

autocompose

conversations

{conversationId}

message-analytic-events

curl --request POST \
  --url https://api.sandbox.asapp.com/autocompose/v1/conversations/{conversationId}/message-analytic-events \
  --header 'Content-Type: application/json' \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>' \
  --data '
{
  "type": "suggestion-1-inserted",
  "suggestionsId": "4d2fd982640c311394008259594399a1"
}
'

This response has no body data.

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "400-01",
    "message": "Bad request"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "401-01",
    "message": "Unauthorized"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "403-01",
    "message": "Forbidden Response"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "404-01",
    "message": "Not Found"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "409-01",
    "message": "Conflict"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "413-01",
    "message": "Request Entity Too Large"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "422-01",
    "message": "Unprocessable Entity"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "429-01",
    "message": "Too Many Requests"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "503-01",
    "message": "Service Unavailable"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "500-01",
    "message": "Internal server error"
  }
}

Authorizations

asapp-api-id

string

header

required

asapp-api-secret

string

header

required

Path Parameters

conversationId

string

required

The identifier for a conversation.

Pattern: ^[A-Z0-9]+$

Body

application/json

The parameters for reporting the analytic event

Analytics event reporting actions the agent performed while composing a message.

type

enum<string>

required

The type of message analytic event.

Available options:

suggestion-1-inserted,

suggestion-2-inserted,

suggestion-3-inserted,

phrase-completion-accepted,

spellcheck-applied,

spellcheck-undone,

custom-response-drawer-inserted,

custom-panel-inserted,

global-panel-inserted

Example:

"suggestion-1-inserted"

suggestionsId

string

required

For suggestion-1-inserted, suggestion-2-inserted, suggestion-3-inserted, phrase-completion-accepted, this is the id from the Suggestions API response that the agent interacted with. This allows ASAPP to connect the event with additional information (e.g., the text of the suggestion that was inserted).

For spellcheck-undone, custom-response-drawer-inserted, custom-panel-inserted, and global-panel-inserted, this is the id of the most recent Suggestions API response in this conversation.

In all of these cases, providing the Suggestions id allows ASAPP to associate the event with the message the agent is composing. During the normal flow of using the AutoCompose API, the Suggestions API will always have been called at least once since the previous agent message by the time a message analytic event occurs, and each time the Suggestions API is called, ASAPP records the ID of the previous agent message. Thus, the Suggestions id in the analytic event links back to the previous agent message. This permits the analytic event to later be linked to the new message the agent is composing, even though the event occurs before the message is sent.

Example:

"4d2fd982640c311394008259594399a1"

spellcheckApplied

object | null

The details about the spellcheck applied analytic event

Show child attributes

spellcheckUndone

object | null

The details about the spellcheck undone analytic event

Show child attributes

customResponseDrawerInserted

object | null

The details about the custom response drawer inserted analytic event

Show child attributes

customPanelInserted

object | null

The details about the custom panel inserted analytic event

Show child attributes

globalPanelInserted

object | null

The details about the global panel inserted analytic event

Show child attributes

Response

Successfully reported selected suggestion