amp events

amp events manages taxonomy: the events in a project. List, create, get, update, and delete require the taxonomy:read and taxonomy:write scopes. Ingestion checks use analytics:read, or an ingestion API key with no OAuth scopes.

`amp events list`

bash

amp events list --project <project_id> --limit 5

In an interactive terminal, amp events list prints a human-friendly table. Pipe the output to a file or another command, or pass --json, to get raw API JSON instead.

`amp events create`

bash

amp events create --project <project_id> --event-type my_event --description "My event"

`amp events get`

bash

amp events get --project <project_id> --event my_event

`amp events update`

Use --project and --event to identify an existing event, then pass the fields to update. Run amp events update --help for the full list of fields it can change, or pass --body-json to merge additional fields into the request:

bash

amp events update --project <project_id> --event my_event --description "Updated description"

`amp events delete`

Preview the deletion with --dry-run. At a terminal, the delete command asks for confirmation; pass --yes to skip the prompt:

bash

amp events delete --project <project_id> --event-type my_event --dry-run   # preview
amp events delete --project <project_id> --event-type my_event --yes       # confirm

`amp events check-ingestion`

Checks whether events reached a project during a recent window. Pass --event-type to check one event type, or omit it to check for any event. The default lookback is 10 minutes. This POST computes a result and doesn't mutate taxonomy.

bash

amp events check-ingestion --project <project_id>
amp events check-ingestion --project <project_id> --event-type my_event
amp events check-ingestion --project <project_id> --lookback-minutes 30 --timeout-seconds 10

observed means at least one matching event was found. not_observed means none were found in the evaluated window. inconclusive means none were found, and complete recent data wasn't available to confirm absence. This command requires the analytics:read scope.

`amp events check-ingestion-by-api-key`

Checks whether Amplitude received any events for the project tied to an ingestion API key during the preceding eight hours. This command doesn't use your OAuth profile or PAT. Pass the project's ingestion API key:

bash

amp events check-ingestion-by-api-key --api-key <ingestion_api_key>
amp events check-ingestion-by-api-key --api-key <ingestion_api_key> --timeout-seconds 10

Configuration documents --project, --json, --dry-run, --yes, and --body-json in full.

Was this helpful?