amp events
このページはまだあなたの言語に翻訳されていません。 現在取り組んでいますので、後でもう一度確認してください。
amp events manages the events in a project's taxonomy. Taxonomy commands use the taxonomy:read and taxonomy:write scopes. Ingestion checks use analytics:read, or an ingestion API key with no OAuth scopes.
amp events list
List event taxonomy entries.
amp events list --project <project_id> --limit 5
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | Yes | Amplitude project identifier, backed by the canonical app ID. Alias: --project-id. |
--cursor | string | No | Opaque cursor from pagination.next_cursor on the previous response. Numeric offsets are capped by the underlying search index (10,000 results per query). Well-formed pagination stops before that window; requests whose cursor would exceed it return 400 pagination_not_supported. Alias: --next-cursor. |
--limit | integer | No | Number of items to return. Defaults to 50, max 200. |
--q | string | No | Full-text search query. Alias: --query. |
Requires the taxonomy:read scope.
amp events get
Get event taxonomy entry.
amp events get --project <project_id> --event <event_type>
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | Yes | Amplitude project identifier, backed by the canonical app ID. Alias: --project-id. |
--event | string | Yes | Public event identifier. This value is the event type name (the string used when sending the event to Amplitude). Alias: --event-id, --event-type. |
Requires the taxonomy:read scope.
amp events create
Create event taxonomy entry.
amp events create --project <project_id> --event-type my_event
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | Yes | Amplitude project identifier, backed by the canonical app ID. Alias: --project-id. |
--idempotency-key | string | No | Generated automatically when omitted. Header acceptance alone does not guarantee retry deduplication. |
--event-type | string | Yes | Alias: --type. |
--description | string | No |
Requires the taxonomy:write scope.
amp events update
Update event taxonomy entry.
Use --project and --event to identify an existing event, then pass the fields to update. Pass --body-json to merge fields that don't have their own flag.
amp events update --project <project_id> --event my_event --description "Updated description"
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | Yes | Amplitude project identifier, backed by the canonical app ID. Alias: --project-id. |
--event | string | Yes | Public event identifier. This value is the event type name (the string used when sending the event to Amplitude). Alias: --event-id, --event-type. |
--idempotency-key | string | No | Generated automatically when omitted. Header acceptance alone does not guarantee retry deduplication. |
--description | string | No | |
--is-active | boolean | No |
Requires the taxonomy:write scope.
amp events delete
Soft-deletes an event. Preview the deletion with --dry-run. At a terminal, the command asks for confirmation; pass --yes to skip the prompt.
amp events delete --project <project_id> --event my_event --dry-run # preview
amp events delete --project <project_id> --event my_event --yes # confirm
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | Yes | Amplitude project identifier, backed by the canonical app ID. Alias: --project-id. |
--event | string | Yes | Public event identifier. This value is the event type name (the string used when sending the event to Amplitude). Alias: --event-id, --event-type. |
--dry-run | boolean | No | Validate request without performing mutation. |
--idempotency-key | string | No | Generated automatically when omitted. Header acceptance alone does not guarantee retry deduplication. |
Requires the taxonomy:write scope.
amp events check-ingestion-by-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.
Checks recent event ingestion using an ingestion API key. This command requires --region <us|eu> and never infers an endpoint from credentials or configuration.
This command doesn't use your OAuth profile or PAT.
amp events check-ingestion-by-api-key --api-key AMPLITUDE_API_KEY --region us
amp events check-ingestion-by-api-key --api-key AMPLITUDE_API_KEY --region us --timeout-seconds 10
| Flag | Type | Required | Description |
|---|---|---|---|
--api-key | string | Yes | Ingestion API key for the Amplitude project to check. |
--timeout-seconds | integer | No | 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. |
amp events check-ingestion
Checks whether events reached an Amplitude project during a recent time window. Provide event_type to check one exact event type, or omit it to check for any event. The default lookback is 10 minutes. The returned window can begin up to five minutes earlier so the evaluation covers the complete starting interval.
observed means at least one matching event was found. not_observed means no matching event was found in the evaluated window. inconclusive means no matching event was found, but complete recent data was not available to confirm its absence. Use the returned window when reporting or comparing results.
This POST computes a result and does not mutate state, so it does not require an Idempotency-Key.
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.
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
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | Yes | Amplitude project identifier, backed by the canonical app ID. Alias: --project-id. |
--event-type | string | No | Exact event type to check. Omit to check for any event. Alias: --type. |
--lookback-minutes | integer | No | Number of recent minutes to evaluate. The returned window can begin up to five minutes earlier to cover the complete starting interval. |
--timeout-seconds | integer | No | 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. |
Requires the analytics:read scope.
amp events scheduled-actions list
List scheduled event deletions and blocks.
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | Yes | Amplitude project identifier, backed by the canonical app ID. Alias: --project-id. |
--cursor | string | No | Opaque cursor from pagination.next_cursor on the previous response. Numeric offsets are capped by the underlying search index (10,000 results per query). Well-formed pagination stops before that window; requests whose cursor would exceed it return 400 pagination_not_supported. Alias: --next-cursor. |
--limit | integer | No | Number of items to return. Defaults to 50, max 200. |
--q | string | No | Full-text search query. Alias: --query. |
--event-type | string | No | Filter list results to a single event type. |
--action | string | No | Filter list results to scheduled deletions or blocks. |
--status | string | No | Filter list results by lifecycle. Omit to return pending actions. |
Requires the taxonomy:read scope.
amp events scheduled-actions get
Get a scheduled event deletion or block.
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | Yes | Amplitude project identifier, backed by the canonical app ID. Alias: --project-id. |
--scheduled-event-action-id | string | Yes | Scheduled event action identifier. |
Requires the taxonomy:read scope.
amp events scheduled-actions create
Each event_type must already exist on the project and may appear only once in items. Update and cancel take scheduled-action ids, so they do not look up the event again. One pending scheduled action is allowed per event type. If that event already has a pending deletion or block, cancel it before creating another. The whole request fails if any item cannot be created.
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | Yes | Amplitude project identifier, backed by the canonical app ID. Alias: --project-id. |
--idempotency-key | string | No | Generated automatically when omitted. Header acceptance alone does not guarantee retry deduplication. |
--items | array | Yes | JSON array, or a comma-separated list for strings. |
Requires the taxonomy:write scope.
amp events scheduled-actions update
The whole request fails if any id is not a pending scheduled action on the project.
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | Yes | Amplitude project identifier, backed by the canonical app ID. Alias: --project-id. |
--idempotency-key | string | No | Generated automatically when omitted. Header acceptance alone does not guarantee retry deduplication. |
--items | array | Yes | JSON array, or a comma-separated list for strings. |
Requires the taxonomy:write scope.
amp events scheduled-actions delete
The whole request fails if any id is not a pending scheduled action on the project.
Requires --yes to apply changes, or --dry-run when supported to validate without applying changes.
| Flag | Type | Required | Description |
|---|---|---|---|
--project | string | Yes | Amplitude project identifier, backed by the canonical app ID. Alias: --project-id. |
--dry-run | boolean | No | Validate request without performing mutation. |
--idempotency-key | string | No | Generated automatically when omitted. Header acceptance alone does not guarantee retry deduplication. |
--ids | array | Yes | JSON array, or a comma-separated list for strings. |
Requires the taxonomy:write scope.
これは役に立ちましたか?
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.