Edit

List - Activities API

  • Article

Run the GET or POST request to fetch a list of activities matching the specified filters.

HTTP request

GET /api/v1/activities/

POST /api/v1/activities/

Request BODY parameters

Parameter Description
filters Filter objects with all the search filters for the request, see activity filters for more details
sortDirection The sorting direction. Possible values are: asc and desc
sortField Fields used to sort activities. Possible values are:
  • date: The date when then the activity happened
  • created: The timestamp when the activity was saved
    		•
    skip Skips the specified number of records
    limit Maximum number of records returned by the request

    Example

    Request

    Here is an example of the request.

    curl -XPOST -H "Authorization:Token <your_token_key>" -H "Content-Type: application/json" "https://<tenant_id>.<tenant_region>.portal.cloudappsecurity.com/api/v1/activities/" -d '{
  "filters": {
    // some filters
  },
  "skip": 5,
  "limit": 10
  ...
}'

    Response

    Returns a list of activities in JSON format.

    {
  "total": 5 // total number of records
  "hasNext": true // whether there is more data to show or not.
  "data": [
    // returned records
  ]
}

    If you run into any problems, we're here to help. To get assistance or support for your product issue, please open a support ticket.