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
Key | Datatype | Required | Description |
---|---|---|---|
createdAt__lt | string | Get activities created before this timestamp. Example: "2018-02-27T04:49:26.257525Z". | |
skip | string | Skip first number of items (0-1000). To iterate over more than 1000 items, use "cursor". Example: "150". | |
sortOrder | string | Sort direction. Example: "asc". | |
createdAt__lte | string | Get activities created before or at this timestamp. Example: "2018-02-27T04:49:26.257525Z". | |
agentIds | string | Return activities related to specified agents. Example: "225494730938493804,225494730938493915". | |
includeHidden | string | Include internal activities hidden from display. Example: "False". | |
activityTypes | string | Return 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". | |||
ids | string | Filter activities by specific activity IDs. Example: "225494730938493804,225494730938493915". | |
ruleIds | string | Return activities related to specified rules. Example: "225494730938493804,225494730938493915". | |
userIds | string | The user who invoked the activity (If applicable). Example: "225494730938493804,225494730938493915". | |
userEmails | string | Email of the user who invoked the activity (If applicable) | |
createdAt__gte | string | Get activities created after or at this timestamp. Example: "2018-02-27T04:49:26.257525Z". | |
siteIds | string | List of Site IDs to filter by. Example: "225494730938493804,225494730938493915". | |
sortBy | string | The column to sort the results by. Example: "id". | |
groupIds | string | List of Group IDs to filter by. Example: "225494730938493804,225494730938493915". | |
limit | string | Limit number of returned items (1-1000). Example: "10". | |
accountIds | string | List of Account IDs to filter by. Example: "225494730938493804,225494730938493915". | |
cursor | string | Cursor position returned by the last request. Use to iterate over more than 1000 items. Example: "YWdlbnRfaWQ6NTgwMjkzODE=". | |
alertIds | string | Return activities related to specified alerts. Example: "225494730938493804,225494730938493915". | |
threatIds | string | Return activities related to specified threats. Example: "225494730938493804,225494730938493915". | |
createdAt__between | string | Get activities created in this range (inclusive) of a start timestamp and an end timestamp. Example: "1514978764288-1514978999999". | |
skipCount | string | If true, total number of items will not be calculated, which speeds up execution time. | |
countOnly | string | If true, only total number of items will be returned, without any of the actual objects. | |
createdAt__gt | string | Get activities created after this timestamp. Example: "2018-02-27T04:49:26.257525Z". |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | null |