Docs Menu
Docs Home
/ /

atlas api activityFeed getGroupActivityFeed

Returns a pre-filtered activity feed link for the specified project based on the provided date range and event types.

The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

The returned link can be shared and opened to view the activity feed with the same filters applied. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or higher.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupactivityfeed.

For more information and examples, see the referenced API documentation linked above.

Command Syntax
atlas api activityFeed getGroupActivityFeed [options]
Name
Type
Required
Description

--clusterName

stringArray

false

Human-readable label that identifies the cluster.

--eventType

stringArray

false

Category of incident recorded at this moment in time.

IMPORTANT: The complete list of event type values changes frequently.

--groupId

string

true

Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.

NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

-h, --help

false

help for getGroupActivityFeed

--maxDate

string

false

End date and time for events to include in the activity feed link. ISO 8601 timestamp format in UTC.

--minDate

string

false

Start date and time for events to include in the activity feed link. ISO 8601 timestamp format in UTC.

-o, --output

string

false

preferred api format, can be ["json", go-template] This value defaults to "json".

--outputFile

string

false

file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)

--pretty

false

Flag that indicates whether the response body should be in the prettyprint format.

--version

string

false

api version to use when calling the api call [options: "2025-03-12"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-03-12".

Name
Type
Required
Description

-P, --profile

string

false

atlas api activityFeed getGroupActivityFeed --version 2025-03-12 --groupId 32b6e34b3d91647abb20e7b8

Back

activityFeed

On this page