This API endpoint allows you to list the alert events for your account.
Alerts events can be filter by product, target type, group ID, instance ID, and event type.
The options for products are: APM, BROWSER, MOBILE, SERVERS, SYNTHETICS, and ALERTS.
The options for entity type are: Application, Server, KeyTransaction, MobileApplication, BrowserApplication, and Monitor.
The options for event type are: NOTIFICATION, DEPLOYMENT, VIOLATION_OPEN, VIOLATION_CLOSE, VIOLATION, and INSTRUMENTATION.
The group option is normally the same as the entity (e.g. an Application group and entity will be the same)
See our documentation for a discussion on output pagination.
' parameters: - name: filter[product] in: query description: Filter by New Relic product schema: type: string example: example_string - name: filter[entity_type] in: query description: Filter by entity type schema: type: string example: standard - name: filter[entity_group_id] in: query description: Filter by entity group ID schema: type: integer example: 100 - name: filter[entity_id] in: query description: Filter by entity ID schema: type: integer example: 100 - name: filter[event_type] in: query description: Filter by event type schema: type: string example: standard - name: filter[incident_id] in: query description: Filter by incident id schema: type: integer example: 100 - name: page in: query description: Pagination index schema: type: integer example: 100 responses: '200': description: No response was specified headers: link: description: 'Links to related resources, in the format defined by [RFC 5988](https://tools.ietf.org/html/rfc5988#section-5). This will include a link with relation type `next` to the next page and `last` to the last page, unless this page is itself the last page. ' schema: type: array items: type: string content: application/json: schema: $ref: '#/components/schemas/RecentEventResponse' examples: Getalertsevents200Example: summary: Default getAlertsEvents 200 response x-microcks-default: true value: recent_event: description: {} entity_group_id: {} entity_id: {} entity_type: {} event_type: {} id: {} incident_id: {} priority: {} product: {} timestamp: {} application/xml: schema: $ref: '#/components/schemas/RecentEventResponse' examples: Getalertsevents200Example: summary: Default getAlertsEvents 200 response x-microcks-default: true value: recent_event: description: {} entity_group_id: {} entity_id: {} entity_type: {} event_type: {} id: {} incident_id: {} priority: {} product: {} timestamp: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: getAlertsEvents x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: RecentEventResponseType: type: object properties: description: type: string example: example_string entity_group_id: type: integer example: 100 entity_id: type: integer example: 100 entity_type: type: string example: standard event_type: type: string example: standard id: type: integer example: 100 incident_id: type: integer example: 100 priority: type: string example: example_string product: type: string example: example_string timestamp: type: integer example: 1718153645993 CustomEvent: type: object description: A custom event to record. Must include eventType. All other attributes are user-defined key-value pairs. Attribute names must not start with nr. (reserved). Values can be strings, numbers, or booleans. required: - eventType properties: eventType: type: string description: The type of event. Used as the NRDB event table name. Must match the pattern [a-zA-Z0-9:_ ]+, max 255 characters. maxLength: 255 example: standard timestamp: type: integer description: Unix epoch timestamp in seconds. If omitted, the current time is used. Cannot be more than 48 hours in the past or 24 hours in the future. example: 1718153645993 additionalProperties: description: Additional user-defined event attributes oneOf: - type: string maxLength: 4096 - type: number - type: boolean EventPayload: type: array description: An array of custom event objects to ingest maxItems: 2000 items: $ref: '#/components/schemas/CustomEvent' SuccessResponse: type: object description: Successful ingestion response properties: success: type: boolean description: Whether the request was accepted example: true uuid: type: string description: Unique request identifier example: '500123' RecentEventResponse: type: object properties: recent_event: $ref: '#/components/schemas/RecentEventResponseType' ErrorResponse: type: object description: Error response properties: success: type: boolean example: false error: type: string description: Error message example: example_string errors: type: array description: List of validation errors items: type: object properties: error: type: string timestamp: type: string example: - error: example_string timestamp: example_string securitySchemes: apiKey: type: apiKey in: header name: Api-Key description: New Relic License Key or Ingest API Key externalDocs: description: New Relic Event API Documentation url: https://docs.newrelic.com/docs/data-apis/ingest-apis/event-api/introduction-event-api/