# Superwall Chart Annotations API

**Canonical:** https://apis.io/apis/superwall/superwall-chart-annotations-api/  
**Provider:** Superwall — https://apis.io/providers/superwall/  
**Base URL:** https://api.superwall.com  
**Documentation:** https://api.superwall.com/docs

Superwall Chart Annotations API is one of 42 APIs that [Superwall](https://apis.io/providers/superwall/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Chart Annotations. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Annotations mark what happened on an application's timeline, such as a release, a feature by the App Store or a marketing campaign. Every time-series chart for the application draws them, for everyone with access to it. An annotation with `end_at: null` is a point: one moment, drawn as a line. With an `end_at` it is a range from `start_at` to `end_at`, drawn as a shaded span. Both are exact instants: send ISO 8601 timestamps with a timezone, and they are returned in UTC. A chart places each annotation in the bucket that contains it, so an hourly chart shows a point at its hour. Reading needs the charts:read scope; creating, updating and deleting need charts:write. An application holds up to 1000 annotations. Deletes are permanent; the audit log records every change.

## Operations (5)

| Method | Path | Summary |
|---|---|---|
| GET | `/v2/applications/{application_id}/chart_annotations` | List Chart Annotations |
| POST | `/v2/applications/{application_id}/chart_annotations` | Create Chart Annotation |
| GET | `/v2/applications/{application_id}/chart_annotations/{chart_annotation_id}` | Retrieve Chart Annotation |
| PATCH | `/v2/applications/{application_id}/chart_annotations/{chart_annotation_id}` | Update Chart Annotation |
| DELETE | `/v2/applications/{application_id}/chart_annotations/{chart_annotation_id}` | Delete Chart Annotation |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/superwall/openapi/superwall-chart-annotations-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/superwall/json-schema/superwall-audit-log-entry-with-actor-schema.json
- **JSONSchema** — https://artifacts.apis.io/superwall/json-schema/superwall-custom-store-event-schema.json
- **JSONSchema** — https://artifacts.apis.io/superwall/json-schema/superwall-rule-conditions-schema.json
- **JSONSchema** — https://artifacts.apis.io/superwall/json-schema/superwall-rule-conditions-1-schema.json
- **JSONSchema** — https://artifacts.apis.io/superwall/json-schema/superwall-doctor-report-schema.json
- **JSONSchema** — https://artifacts.apis.io/superwall/json-schema/superwall-audit-log-list-schema.json

## Other Superwall APIs (12)

- [Superwall App Store Connect Configurations V2 API](https://apis.io/apis/superwall/superwall-app-store-connect-configurations-v2-api/)
- [Superwall App User Erasures V2 API](https://apis.io/apis/superwall/superwall-app-user-erasures-v2-api/)
- [Superwall Application Webapp Origins V2 API](https://apis.io/apis/superwall/superwall-application-webapp-origins-v2-api/)
- [Superwall Assets V2 API](https://apis.io/apis/superwall/superwall-assets-v2-api/)
- [Superwall Audit Logs V2 API](https://apis.io/apis/superwall/superwall-audit-logs-v2-api/)
- [Superwall Campaigns V2 API](https://apis.io/apis/superwall/superwall-campaigns-v2-api/)
- [Superwall Charts V2 API](https://apis.io/apis/superwall/superwall-charts-v2-api/)
- [Superwall CLI Agent V2 API](https://apis.io/apis/superwall/superwall-cli-agent-v2-api/)
- [Superwall Custom Store Events API](https://apis.io/apis/superwall/superwall-custom-store-events-api/)
- [Superwall Custom Stores API](https://apis.io/apis/superwall/superwall-custom-stores-api/)
- [Superwall Demand Score V2 API](https://apis.io/apis/superwall/superwall-demand-score-v2-api/)
- [Superwall Entitlements V2 API](https://apis.io/apis/superwall/superwall-entitlements-v2-api/)

## Tags

Chart Annotations

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/superwall/superwall-chart-annotations-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/superwall/.