GET
/
api
/
v1
/
agent-stats
/
{agentId}
curl --request GET \
  --url https://api.play.ai/api/v1/agent-stats/{agentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-USER-ID: <api-key>'
{
  "id": "f0gZrOKBKL7veJ6o1M",
  "numberOfConversations": 121,
  "numberOfPhoneConversations": 0,
  "numberOfSecondsTalked": 2342
}

Authorizations

​
Authorization
string
header
required

Your secret API key from PlayAI, formatted as Bearer YOUR_SECRET_API_KEY.

​
X-USER-ID
string
header
required

Your unique user ID from PlayAI.

Headers

​
accept
enum<string>
Available options:
application/json

Path Parameters

​
agentId
string
required

The agent's ID.

Example:

"f0gZrOKBKL7veJ6o1M"

Response

200 - application/json
Agent statistics response.
​
id
string
required

The unique ID for each agent.

Example:

"f0gZrOKBKL7veJ6o1M"

​
numberOfConversations
number
required
Example:

121

​
numberOfPhoneConversations
number
required
Example:

0

​
numberOfSecondsTalked
number | null
required
Example:

2342

Was this page helpful?