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.

Get chart

Returns chart metadata. The chart definition is omitted by default. Set
include_definition=true to include a read-only definition object. The
definition shape is unstable and not intended for authoring.

get/v1/projects/{project_id}/charts/{chart_id}

Authorizations

Authorizationstringrequired

http

Path parameters

project_idstringrequired

Amplitude project identifier, backed by the canonical app ID.

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

Saved chart identifier.

Constraints:min length: 1

Query parameters

include_definitionboolean

When true, include the read-only chart definition on GET chart. The definition shape is unstable and not intended for authoring.

Default:false

Response

application/json
200· Successful response.
dataobjectrequired
Show child attributes
idstringrequired

Stable chart identifier.

objectstringrequired

Resource-type discriminator. Always chart.

project_idstringrequired
Constraints:pattern: ^[0-9]+$
namestringrequired
descriptionstring
Constraints:nullable
chart_typestringrequired

Public chart type discriminator (snake_case). All values may appear on list/get; query returns 422 (unsupported_chart_type) for types outside the v1 supported matrix.Unsupported or unrecognized chart types are surfaced as unknown.New chart types may be added over time. Clients should treat unknown as "a chart type this API version does not model yet".

Allowed values:event_segmentationsessionsfunnelsretentioncompositionrevenue_ltvstickinessdata_tableengagement_matrixmetric_explorergrowth_accountingimpactusersunknown
created_atstringrequired

ISO-8601 creation time, or null when unavailable.

Constraints:format: date-timenullable
updated_atstringrequired

ISO-8601 last-modified time, or null when unavailable.

Constraints:format: date-timenullable
created_bystring

Chart creator. The creator's email when available, otherwise a login identifier; null when the creator cannot be resolved.

Constraints:nullable
urlstringrequired

Deep link to the chart in the Amplitude UI.

Constraints:format: uri
archivedbooleanrequired

Whether the chart is archived.

definitionobject

Read-only chart definition. Returned only when include_definition=true on GET chart. Shape is unstable and may change between API versions; not intended for authoring.

Was this helpful?