For AI agents: a documentation index is available at /docs/llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.

Check recent event ingestion with an ingestion API key

Checks whether Amplitude received any events for the project associated
with the supplied ingestion API key during the preceding eight hours.

observed means at least one event was received in the evaluated window.
not_observed means no events were received. inconclusive means no events
were found, but the available data could not confirm their absence. Use the
returned window when reporting or comparing results.

The window uses server upload time: when Amplitude received each event,
rather than the event time supplied by the sender.

Provide polling_timeout_seconds to request server polling guidance.
While another check is advised, successful responses include
poll_after_seconds; its omission means clients should stop polling.

post/v1/events/check-recent-ingestion

Body

application/json
api_keystringrequired

Ingestion API key for the Amplitude project to check.

Constraints:pattern: \S
polling_timeout_secondsinteger

Maximum polling window requested by the caller. Clients should complete the initial check even if it exceeds this window and use the window only to limit subsequent polls. Its presence requests polling guidance; it is not an HTTP request timeout, and each HTTP request performs one check.

Constraints:min: 1max: 120

Response

application/json
200· Recent event ingestion status for the evaluated window.
dataobjectrequired
Show child attributes
statusstringrequired

observed when at least one event was received; not_observed when none were received; inconclusive when none were found but their absence could not be confirmed.

Allowed values:observednot_observedinconclusive
poll_after_secondsinteger

Minimum seconds to wait before the next ingestion check. Returned only when polling was requested and another check is advised. Its omission means the server does not advise another check.

Constraints:min: 1
windowobjectrequired
lookback_hoursintegerrequired

Number of hours evaluated.

startstringrequired

Start of the evaluated window.

Constraints:format: date-time
endstringrequired

End of the evaluated window.

Constraints:format: date-time
basisstringrequired

The window is based on when Amplitude received each event.

401· The supplied API key is invalid.
typestringrequired
Constraints:format: uri
titlestringrequired
statusintegerrequired
Constraints:min: 400max: 599
detailstring
Constraints:nullable
instancestring
Constraints:format: urinullable
error_codestringrequired
retryablebooleanrequired
retry_after_secondsinteger
Constraints:nullablemin: 0
validation_errorsobject[]
Constraints:nullable
403· The endpoint is unavailable.
typestringrequired
Constraints:format: uri
titlestringrequired
statusintegerrequired
Constraints:min: 400max: 599
detailstring
Constraints:nullable
instancestring
Constraints:format: urinullable
error_codestringrequired
retryablebooleanrequired
retry_after_secondsinteger
Constraints:nullablemin: 0
validation_errorsobject[]
Constraints:nullable
502· The ingestion status could not be determined. Retryable responses use unreliable_dataset_response or upstream_error as the error_code.
typestringrequired
Constraints:format: uri
titlestringrequired
statusintegerrequired
Constraints:min: 400max: 599
detailstring
Constraints:nullable
instancestring
Constraints:format: urinullable
error_codestringrequired
retryablebooleanrequired
retry_after_secondsinteger
Constraints:nullablemin: 0
validation_errorsobject[]
Constraints:nullable
503· Endpoint not available.
typestringrequired
Constraints:format: uri
titlestringrequired
statusintegerrequired
Constraints:min: 400max: 599
detailstring
Constraints:nullable
instancestring
Constraints:format: urinullable
error_codestringrequired
retryablebooleanrequired
retry_after_secondsinteger
Constraints:nullablemin: 0
validation_errorsobject[]
Constraints:nullable

Was this helpful?