Chart Annotations

List Chart Annotations

Changed on

Lists the application's annotations by start_at. With from and/or to, returns only those that overlap the window: a point at or between them, or a range that starts at or before to and ends at or after from. In the query string, write the instants in UTC (Z) or encode + as %2B. Requires charts:read scope.

get/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

Query parameters

fromstring date-time

Only annotations that end at or after this instant.

tostring date-time

Only annotations that start at or before this instant.

Response

Success

object'list' required
can_writeboolean required

Whether the caller can create, update and delete annotations (charts:write).

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

    • info

      endpoint added