You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/includes/_activity.md
+6-7Lines changed: 6 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Activity
2
2
3
-
Using the Activity API, you can retrieve performance metrics on your team operating within Lexer Engage. Access insightful metrics such as the number of closed cases, average response time, or your overall NPS score for last month. We’ve made your Activity data accessible so you can run bespoke reports or add them to your custom applications.
3
+
Using the Activity API, you can retrieve performance data on your team operating within Lexer Engage. Access insightful metrics such as the number of closed cases, average response time, or your overall NPS score for last month. We’ve made your Activity data accessible so you can run bespoke reports or add them to your custom applications.
4
4
5
5
Our API is organised into two sections; Get and Post requests. Get requests allow you to access the user, groups and forms information related to your team. These are useful for filtering your reports. Post requests are queries that comprise of particular report types and filter parameters. Reports may be filtered by users, groups, forms or time.
6
6
@@ -12,11 +12,11 @@ You will need an API token to access your Activity data. Tokens are managed with
12
12
13
13
Retrieve a list of users that have access to your Lexer account. You can use these user details to filter any of the Activity queries for agent specific metrics. Here we'll describe how you request and interpret this information.
14
14
15
-
**Request**
16
-
```text
15
+
**Endpoint**
16
+
```json
17
17
curl -H "Content-Type: application/json" -H "Auth-Api-Token: 12345678-1234-1234-1234-123456789" -X GET https://api.lexer.io/v1/users
18
18
```
19
-
Simply call this endpoint `https://api.lexer.io/v1/users` using your API token and you will retrieve a list of active users in your team.
19
+
https://api.lexer.io/v1/users
20
20
21
21
```json
22
22
[
@@ -38,7 +38,6 @@ Simply call this endpoint `https://api.lexer.io/v1/users` using your API token a
38
38
}
39
39
```
40
40
41
-
**Response**
42
41
43
42
Property | Description | Type |
44
43
---------|-------------|------|
@@ -49,9 +48,9 @@ last_name | last name of the user | string
49
48
timezone | timezone location of user | string
50
49
gmtoffset | timezone offset of user | integer
51
50
sign_in_count | count of logins | integer
52
-
last_sign_in_at | date time of the users last login | string
51
+
last_sign_in_at | date of users last login | string
53
52
archived | archived flag for user | boolean
54
-
groups | group id's the user is a member of | array
0 commit comments