List scheduled event deletions and blocks

このページはまだあなたの言語に翻訳されていません。 現在取り組んでいますので、後でもう一度確認してください。

get/v1/projects/{project_id}/scheduled-event-actions

Authorizations

Authorizationstringrequired

http

Path parameters

project_idstringrequired

Amplitude project identifier, backed by the canonical app ID.

Example:12345
Constraints:pattern: ^[0-9]+$

Query parameters

cursorstring

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.

Constraints:nullable
limitinteger

Number of items to return. Defaults to 50, max 200.

Default:50
Constraints:min: 1max: 200
qstring

Full-text search query.

event_typestring

Filter list results to a single event type.

Constraints:min length: 1
actionstring

Filter list results to scheduled deletions or blocks.

Allowed values:deleteblock
statusstring

Filter list results by lifecycle. Omit to return pending actions.

Allowed values:pendingcanceledcompleted

Response

application/json
200· Successful response. Defaults to pending actions.
dataobject[]required
Show child attributes
idstringrequired

Stable scheduled-action identifier.

objectstringrequired

Resource-type discriminator. Always scheduled_event_action.

project_idstringrequired
Constraints:pattern: ^[0-9]+$
event_typestringrequired
display_namestringrequired

Event display name when known; otherwise equal to event_type.

actionstringrequired

Work to apply when target_date arrives. delete removes the event from the tracking plan (soft-delete if ingested). block stops ingestion.

Allowed values:deleteblock
target_datestringrequired
Constraints:format: date-time
statusstringrequired

Lifecycle of a scheduled event action. List defaults to pending.

Allowed values:pendingcanceledcompleted
created_atstringrequired

When the action was scheduled.

Constraints:format: date-time
created_bystringrequired

Login id of the user who scheduled the action.

paginationobjectrequired
Show child attributes
next_cursorstringrequired

Cursor for the next page, or null on the last page. Chart list responses may stop before all project charts are enumerated because the search backend caps each query at 10,000 sorted hits.

Constraints:nullable
has_morebooleanrequired

これは役に立ちましたか?

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.