You are viewing the Apigee Management API reference documentation. For the main product docs, and to search all docs, go to https://docs.apigee.com.

Get user activity (Beta)

GetuseractivityBeta

GET

Get user activity (Beta)

Get user activity details for a given user in specified time range.

Only available for Edge for Cloud Enterprise customers with the Advanced API Ops option.

 

Returning results in pages

By default, this API returns all activity details in a single logs array as part of the response object. Because there can be a large number of entries in the logs array, you can configure the API to return the results as a collection of pages. For example:

 

  • On the first call, return the first 25 results in the logs array. This response contains the first results page.
  • On the second call, return the next 25 results. This response contains the second results page.
  • Continue until you have returned all entries in the logs array.

 

To configure the API to return results as a collection of pages:

 

  1. On the first call, pass the page.size query parameter specifying the number of results to return per page.
    https://apisecurity.enterprise.apigee.com/security/users/activity?org={org}&from={start}&to={end}&email={email}&page.size=25
  2. The response object contains the page.nextPageToken property that identifies the second page of results:
    "page": {
      "current": 0,
      "total": 0,
      "nextPageToken": "TOKEN"
    },
    Note that current and total are always set to 0.
  3. On the second API request, pass the TOKEN as the value of the page.pageToken query parameter to obtain the second page of results.
    https://apisecurity.enterprise.apigee.com/security/users/activity?org={org}&from={start}&to={end}&email={email}&page.size=25&page.pageToken=TOKEN
  4. The second page of results contains a new TOKEN value that identifies the third page.
  5. Pass the new TOKEN to the API to obtain the third page of results.
  6. Repeat steps 4 and 5 until you have received all the resutls.

 

Resource URL

https://apisecurity.enterprise.apigee.com /security/users/activity

Query Parameters


Name Values Description
org
(required)

Organization for the data requested.

email
(required)

Email address of user.

from
(required)

Start of the time period to analyze, inclusive. Specify the time in the ISO format: "yyyy-mm-ddThh:mm:ssZ". For example: "2018-07-29T00:13:00Z".

to
(required)

End of the time period to analyze, exclusive. Specify the time in the ISO format: "yyyy-mm-ddThh:mm:ssZ". For example: "2018-07-29T00:13:00Z".

log_type

Type of log activity to return. Supported values include: ALL (default), UI, and API.

page.size

Specifies the number of results to return per page of results. The maximum value is 5000.

To obtain the first page of results, specify only the page.size query parameter. Each page of results contains the nextPageToken property. Pass the value of nextPageToken on each subsequent request.

page.pageToken

Specifies the page token that identifies the page of results to return.

To obtain the first page of results, specify only the page.size query parameter. The result object of the first page of results contains the nextPageToken property. Pass the value of nextPageToken on the second request to return the second page of results.

Each results object contains a new value for nextPageToken that identifies the next page of the results to return.


Header Parameters


Name Values Description
Authorization
(required)

OAuth token. Replace $TOKEN with your access token. See Get the tokens.

Request Body

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Resource Summary

Security

Content Type

application/json

Category

UserActivityService

Working...

Help or comments?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click the "Send Feedback" button.
    (Incorrect? Unclear? Broken link? Typo?)