Event Streaming Metrics Summary API

Use the Event Streaming Metrics API to monitor delivery metrics for your event streams.

Authorization¶

This API uses basic authentication, using the API key and secret key for your project. Pass base64-encoded credentials in the request header like {{api-key}}:{{secret-key}}. api-key replaces username, and secret-key replaces the password.

Your authorization header should look something like this:

--header 'Authorization: Basic YWhhbWwsdG9uQGFwaWdlZS5jb206bClwYXNzdzByZAo'

See Find your Amplitude Project API Credentials for help locating your credentials.

Endpoints¶

Considerations¶

• The latest 4 hours of data is accurate to the minute. Beyond that, the data is aggregated internally for every hour. Consider this when requesting metric data older than 4 hours.
• Amplitude retains event streaming metrics for the last 90 days. Sending start or end time beyond this threshold returns a 500 status.

Limits¶

The API has a limit of 4 concurrent requests per project, and 12 requests per minute per project. Amplitude rejects anything above this threshold with a 429 status code.

Example request¶

Send a GET request with required and optional parameters to https://analytics.amplitude.com/api/2/event-streaming/delivery-metrics-summary.

Here is a basic request with only the required parameters.

curl --location --request GET 'https://analytics.amplitude.com/api/2/event-streaming/delivery-metrics-summary?sync_id=SYNC_ID&time_period=TIME_PERIOD' \
-u '{api_key}:{secret_key}'

GET /api/2/event-streaming/delivery-metrics-summary?sync_id=SYNC_ID&time_period=TIME_PERIOD HTTP/1.1
Host: analytics.amplitude.com
Authorization: Basic {{api-key}}:{{secret-key}} #credentials must be base64-encoded

curl --location --request GET 'https://analytics.amplitude.com/api/2/event-streaming/delivery-metrics-summary?sync_id=30001625&time_period=FOUR_HOURS' \
--header 'Authorization: Basic MTIzNDU2NzgwMDoxMjM0NTY3MDA='

GET /api/2/event-streaming/delivery-metrics-summary?sync_id=30001625&time_period=FOUR_HOURS HTTP/1.1
Host: analytics.amplitude.com
Authorization: Basic MTIzNDU2NzgwMDoxMjM0NTY3MDA=

curl --location --request GET 'https://analytics.amplitude.com/api/2/event-streaming/delivery-metrics-summary?sync_id=30001625&time_period=ONE_HOUR' \
--header 'Authorization: Basic MTIzNDU2NzgwMDoxMjM0NTY3MDA='

GET /api/2/event-streaming/delivery-metrics-summary?sync_id=30001625&time_period=ONE_HOUR HTTP/1.1
Host: analytics.amplitude.com
Authorization: Basic MTIzNDU2NzgwMDoxMjM0NTY3MDA=

curl --location --request GET 'https://analytics.amplitude.com/api/2/event-streaming/delivery-metrics-summary?sync_id=30001625&time_period=CUSTOM&start=2022-10-01T07:00:00+01:00&end=end=2022-10-31T07:00:00+01:00' \
--header 'Authorization: Basic MTIzNDU2NzgwMDoxMjM0NTY3MDA='

GET /api/2/event-streaming/delivery-metrics-summary?sync_id=30001625&time_period=CUSTOM&start=2022-10-01T07:00:00+01:00&end=2022-10-31T07:00:00+01:00 HTTP/1.1
Host: analytics.amplitude.com
Authorization: Basic MTIzNDU2NzgwMDoxMjM0NTY3MDA=

Query parameters¶

Response¶

The response is a JSON blob with the retrieved delivery metrics for the specific sync.

Response schema¶

{
  "timePeriod": string    // The time_period sent in the request
  "eventsDelivered": int    // Total number of events delivered
  "eventsNotDelivered": int     // Total number of events not delivered
  "deliveryRate": double       // The delivery success rate
  "latencyInSeconds": double     // The p95 latency in seconds 
  "timePeriodStart": string     // The UTC (ISO-8601) timestamp for the request start time
  "timePeriodEnd": string     // The UTC (ISO-8601) timestamp for the request end time
  "successOnFirstAttempt": int   // Events delivered successfully in the first attempt
  "successAfterRetry": int     // Events delivered successfully after one or more retries
  "eventsExpired": int       // Events that were not sent after all retry attempts
  "eventsDiscarded": int       // Events that were not sent due to data incomplete/invalid
}

Example response¶

{
  "timePeriod": "CUSTOM",
  "eventsDelivered": 19,
  "eventsNotDelivered": 0,
  "deliveryRate": 1.0,
  "latencyInSeconds": 5.098051910578275,
  "timePeriodStart": "2022-10-01 06:00:00.000000",
  "timePeriodEnd": "2022-10-31 06:00:00.000000",
  "successOnFirstAttempt": 19,
  "successAfterRetry": 0,
  "eventsExpired": 0,
  "eventsDiscarded": 0
}

Status codes¶