Skip to content

Commit b8e7979

Browse files
committed
Fixing users
making it simpler, fixing the json bit
1 parent 1ed2ee0 commit b8e7979

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

source/includes/_activity.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Activity
22

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.
44

55
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.
66

@@ -12,11 +12,11 @@ You will need an API token to access your Activity data. Tokens are managed with
1212

1313
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.
1414

15-
**Request**
16-
```text
15+
**Endpoint**
16+
```json
1717
curl -H "Content-Type: application/json" -H "Auth-Api-Token: 12345678-1234-1234-1234-123456789" -X GET https://api.lexer.io/v1/users
1818
```
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
2020

2121
```json
2222
[
@@ -38,7 +38,6 @@ Simply call this endpoint `https://api.lexer.io/v1/users` using your API token a
3838
}
3939
```
4040

41-
**Response**
4241

4342
Property | Description | Type |
4443
---------|-------------|------|
@@ -49,9 +48,9 @@ last_name | last name of the user | string
4948
timezone | timezone location of user | string
5049
gmtoffset | timezone offset of user | integer
5150
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
5352
archived | archived flag for user | boolean
54-
groups | group id's the user is a member of | array
53+
groups | groups the user is in | array
5554

5655

5756
## GET Groups

0 commit comments

Comments
 (0)