---
title: Retrieve events
description: The detailed information for one or more events can be retrieved, with optional filtering, based on the following API definition.
component: pingdirectory
version: 9.3
page_id: pingdirectory:pingdatametrics_server_administration_guide:pd_met_retrieve_events
canonical_url: https://docs.pingidentity.com/pingdirectory/9.3/pingdatametrics_server_administration_guide/pd_met_retrieve_events.html
revdate: September 13, 2023
---

# Retrieve events

The detailed information for one or more events can be retrieved, with optional filtering, based on the following API definition.

|                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| URL              | `/api/v1/events/[?query-parameters]` retrieves a list of events.`/api/v1/events/{eventId}` retrieves a single event.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| Method           | GET                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Formats          | JSON, XML                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| Query Parameters | * `type`

  Limits the result to include only events of the specified types. See the HTML API Reference for event types.

* `severity`

  Limits the result to include only events that have the matching severity. Valid severity values are: INFO, WARNING, ERROR, and FATAL.

* `instance`, `instanceType`, `instanceLocation`, `instanceHostname`, `instanceVersion`, `startTime`, and `endTime`.

  For a description of each parameter, see [Perform a metric query](pd_met_perform_metric_query.html).

* `limit`, `offset`

  For a description of each parameter, see [Pagination](pd_met_pagination.html). |

|               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Response Code | 200 0K                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Response Body | ```json
{
  "found" : 2,
  "offset" : 0,
  "events" : [

{"id":"9bdfd1b8-3811-4a84-b779-93553ff35f83",
	"creationDate":1351274815559,
	"eventType":"server-starting",
	"eventSeverity":"INFO",
	"sourceProductInstance":"lockdown-test",
	"summary":"Server Starting",
	"detail":"The Directory Server is starting"},
 {"id":"9bdfd1b8-3811-4a84-b779-93553ff35f83",
	"creationDate":1351274815559,
	"eventType":"server-starting",
	"eventSeverity":"INFO",
	"sourceProductInstance":"directory-3",
	"summary":"Server Starting",
	"detail":"The Directory Server is starting"}
  ]
}
``` |