SUsuperwall
Chart Annotations

Create Chart Annotation

Changed on

Adds a point (omit end_at) or a range (end_at after start_at) to every chart for the application. Requires charts:write scope.

post/v2/applications/{application_id}/chart_annotations

Request

  • Base URL
    https://api.superwall.com
  • URL
    https://api.superwall.com/v2/applications/{application_id}/chart_annotations
  • Auth
    • HTTP bearer
    • or API key in cookie accounts_superwall_token
    • or HTTP bearer

Path parameters

application_idstring required

Request body

labelstring required

What happened, shown on the chart. 1-191 characters; leading and trailing whitespace is removed.

descriptionstring

Optional detail, up to 2000 characters.

start_atstring date-time required

The moment, or the start of the span: an ISO 8601 timestamp with a timezone (Z or ±hh:mm). Stored as a UTC instant.

end_atstring date-time nullable

The end of the span, after start_at. Omit or send null for a point.

Example request

{
  "label": "v4.2.0 released",
  "start_at": "2026-10-03T14:00:00Z"
}

Response

Success

object'chart_annotation' required
idstring required
application_idstring required
labelstring required
descriptionstring nullable required
start_atstring required

The moment, or the start of the span. ISO 8601 UTC with milliseconds.

end_atstring nullable required

The end of the span, or null for a point. ISO 8601 UTC with milliseconds.

created_atstring required

ISO 8601 timestamp

updated_atstring required

ISO 8601 timestamp

Changes

  • 778a11cd2c15Revision changes
    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 from the response body anyOf list for the response status

  • 7e65bcbd2cceRevision changes
    • info

      endpoint added