Skip to main content
GET
/
agents
/
{agentId}
/
audit-logs
Fetch Agent Audit Logs
curl --request GET \
  --url https://api.chat-dash.com/v1/public/agents/{agentId}/audit-logs \
  --header 'Authorization: <authorization>'
{
  "success": true,
  "data": [
    {
      "_id": "<string>",
      "conversationId": "<string>",
      "agentId": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "user": {
        "id": "<string>",
        "name": "<string>"
      },
      "eventDetails": {}
    }
  ],
  "pagination": {
    "limit": 123,
    "skip": 123,
    "count": 123
  }
}

Headers

​
Authorization
string
required

All requests to the ChatDash API must be validated with the agency API Key found on your agency profile

Path Parameters

​
agentId
string
required

The ID of the agent

Query Parameters

​
eventType
enum<string>

Filter logs by event type

Available options:
ASSIGNMENT,
TAG_UPDATE
​
startDate
string<date-time>

Start date for filtering logs (ISO 8601)

​
endDate
string<date-time>

End date for filtering logs (ISO 8601)

​
conversationId
string

Optional conversation ID to scope results to one conversation

​
limit
integer

Maximum number of logs to return (default: 100)

Required range: x >= 1
​
skip
integer

Number of logs to skip for pagination (default: 0)

Required range: x >= 0

Response

OK

​
success
boolean
Example:

true

​
data
object[]
​
pagination
object