- API >
- API Resources >
- Events
Get All Organization Events¶
The Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.
To learn how to configure API access for an Atlas project, see Configure Atlas API Access.
https://cloud.mongodb.com/api/atlas/v1.0
Syntax¶
GET /orgs/{ORG-ID}/events
Request Path Parameters¶
Path Element | Required/Optional | Description |
---|---|---|
ORG-ID | Required | The unique identifier for the organization whose events you want to retrieve. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
Request Query Parameters¶
Name | Type | Description | Default | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
pageNum | integer | Page number (1-based). | 1 | ||||||||||||||||||||
itemsPerPage | integer | Number of items to return per page, up to a maximum of 500. | 100 | ||||||||||||||||||||
includeCount | boolean | Specifies whether the response returns the totalCount field. | true | ||||||||||||||||||||
pretty | boolean | Display response in a prettyprint format. | false | ||||||||||||||||||||
envelope | boolean | Specifies whether or not to wrap the response in an envelope. | false | ||||||||||||||||||||
clusterNames | string | Returns events which occurred on the specified cluster. To return
events from multiple clusters, specify multiple
| |||||||||||||||||||||
eventType | string | Returns events whose event type matches the specified value. Possible values include:
| |||||||||||||||||||||
minDate | date | Returns events whose created date is greater than or equal to the
specified ISO-8601 minDate . | |||||||||||||||||||||
maxDate | date | Returns events whose created date is less than or equal to the
specified ISO-8601 maxDate . | |||||||||||||||||||||
includeRaw | boolean | Specifies whether to include the Important The values in the | false |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
Response Document¶
The response JSON document includes an array of result objects, an array of link objects, and a count of the total number of result objects retrieved.
Name | Type | Description |
---|---|---|
results | object array | Includes one object for each item detailed in the results array section. |
links | object array | Includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification. |
totalCount | number | Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated. |
results
array¶
Name | Type | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
alertId | string | Unique identifier for the alert associated to the event. | ||||||||||||||||||||
alertConfigId | string | Unique identifier for the alert configuration associated to the
alertId . | ||||||||||||||||||||
apiKeyId | string | Unique identifier for the API Key that triggered the event. If this field is
present in the response, Atlas does not return the
userId field. | ||||||||||||||||||||
collection | string | Name of the collection on which the event occurred. This field
can be present when the eventTypeName is either
DATA_EXPLORER or DATA_EXPLORER_CRUD . | ||||||||||||||||||||
created | date | ISO 8601-formatted UTC date when the event occurred. | ||||||||||||||||||||
currentValue | document | Describes the value of the metricName at the time of the
event. | ||||||||||||||||||||
currentValue.number | int | The value of the metricName at the time of the event. | ||||||||||||||||||||
currentValue.units | string | The unit of measurement of the Possible values are:
| ||||||||||||||||||||
database | string | Name of the database on which the event occurred. This field
can be present when the eventTypeName is either
DATA_EXPLORER or DATA_EXPLORER_CRUD . | ||||||||||||||||||||
eventTypeName | string | The type of event. Possible values are:
| ||||||||||||||||||||
groupId | string | The unique identifier for the project in which the event occurred. | ||||||||||||||||||||
hostname | string | The hostname of the Atlas host machine associated to the event. | ||||||||||||||||||||
id | string | The unique identifier for the event. | ||||||||||||||||||||
invoiceId | string | The unique identifier of the invoice associated to the event. | ||||||||||||||||||||
isGlobalAdmin | boolean | Indicates whether the user who triggered the event is a MongoDB employee. | ||||||||||||||||||||
links | array | One or more links to sub-resources and/or related resources. The relation-types between URL |