Get Activities

GET {{baseUrl}}/web/api/v2.1/activities?createdAt__lt=ex&skip=ex&sortOrder=ex&createdAt__lte=ex&agentIds=ex&includeHidden=ex&activityTypes=ex&ids=ex&ruleIds=ex&userIds=ex&userEmails=ex&createdAt__gte=ex&siteIds=ex&sortBy=ex&groupIds=ex&limit=ex&accountIds=ex&cursor=ex&alertIds=ex&threatIds=ex&createdAt__between=ex&skipCount=ex&countOnly=ex&createdAt__gt=ex

Get the activities, and their data, that match the filters. We recommend that you set some values for the filters. The full list will be too large to be useful.

Request Params

KeyDatatypeRequiredDescription
createdAt__ltstringGet activities created before this timestamp. Example: "2018-02-27T04:49:26.257525Z".
skipstringSkip first number of items (0-1000). To iterate over more than 1000 items, use "cursor". Example: "150".
sortOrderstringSort direction. Example: "asc".
createdAt__ltestringGet activities created before or at this timestamp. Example: "2018-02-27T04:49:26.257525Z".
agentIdsstringReturn activities related to specified agents. Example: "225494730938493804,225494730938493915".
includeHiddenstringInclude internal activities hidden from display. Example: "False".
activityTypesstringReturn only these activity codes (comma-separated list).
Select a code from the drop-down, or see the id field from the Get activity types command. . Example: "52,53,71,72".
idsstringFilter activities by specific activity IDs. Example: "225494730938493804,225494730938493915".
ruleIdsstringReturn activities related to specified rules. Example: "225494730938493804,225494730938493915".
userIdsstringThe user who invoked the activity (If applicable). Example: "225494730938493804,225494730938493915".
userEmailsstringEmail of the user who invoked the activity (If applicable)
createdAt__gtestringGet activities created after or at this timestamp. Example: "2018-02-27T04:49:26.257525Z".
siteIdsstringList of Site IDs to filter by. Example: "225494730938493804,225494730938493915".
sortBystringThe column to sort the results by. Example: "id".
groupIdsstringList of Group IDs to filter by. Example: "225494730938493804,225494730938493915".
limitstringLimit number of returned items (1-1000). Example: "10".
accountIdsstringList of Account IDs to filter by. Example: "225494730938493804,225494730938493915".
cursorstringCursor position returned by the last request. Use to iterate over more than 1000 items. Example: "YWdlbnRfaWQ6NTgwMjkzODE=".
alertIdsstringReturn activities related to specified alerts. Example: "225494730938493804,225494730938493915".
threatIdsstringReturn activities related to specified threats. Example: "225494730938493804,225494730938493915".
createdAt__betweenstringGet activities created in this range (inclusive) of a start timestamp and an end timestamp. Example: "1514978764288-1514978999999".
skipCountstringIf true, total number of items will not be calculated, which speeds up execution time.
countOnlystringIf true, only total number of items will be returned, without any of the actual objects.
createdAt__gtstringGet activities created after this timestamp. Example: "2018-02-27T04:49:26.257525Z".

HEADERS

KeyDatatypeRequiredDescription
Content-Typenull