Others

Others related APIs

Summary Analytics

get

Provides various summarized analytics information for your project.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

application/json

startDatestringOptional

Start of range of dates to query in YYYY-MM-DD format.

endDatestringOptional

End of range of dates to query in YYYY-MM-DD format.

Responses

200

Successfully retrieved analytics data

application/json

get

/webapi/summary_analytics

HTTPcURLJavaScriptPython

GET /webapi/summary_analytics HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "startDate": "text",
  "endDate": "text"
}

200

Successfully retrieved analytics data

{
  "result": {
    "conversations": 1,
    "conversationsUpDown": 1,
    "participants": 1,
    "participantsUpDown": 1,
    "uniqueParticipants": 1,
    "uniqueParticipantsUpDown": 1,
    "queries": 1,
    "queriesUpDown": 1,
    "queriedUsers": 1,
    "queriedUsersUpDown": 1,
    "uniqueQueriedUsers": 1,
    "uniqueQueriedUsersUpDown": 1,
    "instantResolution": 1,
    "instantResolutionUpDown": 1,
    "aiResponseRate": 1,
    "aiResponseRateUpDown": 1,
    "uniqueVisitors": 1,
    "uniqueVisitorsUpDown": 1,
    "totalFaqs": 1,
    "totalFaqsUpDown": 1,
    "totalDocuments": 1,
    "totalDocumentsUpDown": 1,
    "feedbacksUpDown": 1
  },
  "errors": {}
}