> ## Documentation Index > Fetch the complete documentation index at: https://www.getsoundlink.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # List campaign activity > Returns a page of creative adds, creative pause/resume (user request or Meta sync), budget changes, tier updates, country updates, playlist redirect heals, and auto-renew changes for one campaign. Each item is an event type, a timestamp, and a short summary. Replacing a creative appears as a pause of the old creative plus `CAMPAIGN_AD_CREATIVES_ADDED` for the new one. The list does not include campaign creation. Fee amounts, Stripe ids, and internal file URIs are omitted. `startDate` keeps events at or after that moment. A calendar date starts at 00:00:00Z. Omit it to page through the full history. Any waiting rule, such as 72 hours after a change, is applied by the caller. Requires the `campaigns:read` scope. Accepts API key or OAuth Bearer. ## OpenAPI ````yaml /openapi/soundlink-public-api-v1.yaml get /v1/campaigns/{campaignId}/activity openapi: 3.0.3 info: title: Soundlink Public API version: 0.0.1-draft description: > Campaign listing, metrics, and write operations for Soundlink partner organizations. **Base URL:** `https://api.getsoundlink.com` ## Authentication Send `Authorization: Bearer` with one of: 1. **API key (recommended)** — a `sk_*` key from the Soundlink app (Settings → Developer → API keys): ``` Authorization: Bearer sk_abc123_ ``` 2. **OAuth Bearer** — an access token from Sign in with Soundlink (authorization code or client credentials). Token scopes use the same strings as Public API key scopes (for example `campaigns:read`, `metrics:read`): ``` Authorization: Bearer ``` `x-api-key` is no longer accepted and is ignored if sent. Requests without `Authorization: Bearer` return `401 invalid_api_key` (or `401 invalid_token` when a Bearer value is present but neither a recognized `sk_*` key nor a valid OAuth access token). ### Which operations accept OAuth? | Operations | Required scope | Auth | | --- | --- | --- | | `GET /v1/ping` | any granted Public API scope | API key (Bearer) or OAuth Bearer | | Campaign reads (`GET /v1/strategies`, `GET /v1/campaigns`, campaign detail, tiers) | `campaigns:read` | API key (Bearer) or OAuth Bearer | | Metrics reads (overview, breakdown, exports) | `metrics:read` | API key (Bearer) or OAuth Bearer | | Campaign listening insights + campaign cohort retention (**Label / Enterprise / committed / self-serve**) | `metrics:read` | API key (Bearer) or OAuth Bearer | | Campaign writes (create, stop, budget, tier updates) | `campaigns:write` | API key (Bearer) or OAuth Bearer | | Pixel reads (`GET /v1/pixels`) | `pixels:read` | API key (Bearer) or OAuth Bearer | | Pixel writes (save pixel, test events) | `pixels:write` | API key (Bearer) or OAuth Bearer | | Video import / import status | `videos:write` | API key (Bearer) or OAuth Bearer | | Soundlink reads (list, detail, metrics overview/breakdown/engagement, JSONL exports) | `soundlinks:read` | API key (Bearer) or OAuth Bearer | | Soundlink listening insights + soundlink cohort retention (**Label / Enterprise / committed / self-serve**) | `soundlinks:read` | API key (Bearer) or OAuth Bearer | | Soundlink writes (create, archive, test events) | `soundlinks:write` | API key (Bearer) or OAuth Bearer | | Wallet read (`GET /v1/wallet`) | `wallet:read` | API key (Bearer) or OAuth Bearer | Per-operation scope requirements are also marked with `x-required-scope` (except `GET /v1/ping`, which accepts any valid credential with at least one Public API scope granted to the key/token). All responses are wrapped in a standard envelope: ```json { "data": , "meta": { "requestId": "" } } ``` Errors follow the same envelope shape with an `error` field instead of `data`. servers: - url: https://api.getsoundlink.com description: Production security: - apiKeyBearerAuth: [] - oauthBearer: [] tags: - name: System description: Connectivity and auth verification - name: Wallet description: Organization wallet balance - name: Pixels description: Organization ad pixels that receive a copy of Soundlink conversion events - name: Campaigns description: >- Campaign listing, detail, creation, and wallet management (budget, stop, tiers) - name: Metrics description: Campaign performance metrics - name: Videos description: Partner video library import for Full Control campaigns - name: Soundlinks description: Soundlink listing, detail, creation, archive, and performance metrics paths: /v1/campaigns/{campaignId}/activity: get: tags: - Campaigns summary: List campaign activity description: > Returns a page of creative adds, creative pause/resume (user request or Meta sync), budget changes, tier updates, country updates, playlist redirect heals, and auto-renew changes for one campaign. Each item is an event type, a timestamp, and a short summary. Replacing a creative appears as a pause of the old creative plus `CAMPAIGN_AD_CREATIVES_ADDED` for the new one. The list does not include campaign creation. Fee amounts, Stripe ids, and internal file URIs are omitted. `startDate` keeps events at or after that moment. A calendar date starts at 00:00:00Z. Omit it to page through the full history. Any waiting rule, such as 72 hours after a change, is applied by the caller. Requires the `campaigns:read` scope. Accepts API key or OAuth Bearer. operationId: getCampaignActivity parameters: - $ref: '#/components/parameters/campaignId' - name: startDate in: query schema: type: string description: | Return events at or after this moment. `YYYY-MM-DD` starts at 00:00:00Z. An ISO-8601 timestamp uses that instant. - name: page in: query schema: type: integer minimum: 1 default: 1 description: Page number (1-indexed). - name: pageSize in: query schema: type: integer minimum: 1 maximum: 100 default: 20 description: Items per page (max 100). responses: '200': description: Campaign activity page content: application/json: schema: $ref: '#/components/schemas/CampaignActivityResponse' example: data: items: - event_type: CAMPAIGN_CREATIVE_STATUS_UPDATE_REQUESTED timestamp: '2026-03-03T12:00:00.000Z' summary: Creative paused by user - event_type: CAMPAIGN_AD_CREATIVES_ADDED timestamp: '2026-03-02T15:04:05.000Z' summary: Creatives added (2) - event_type: BUDGET_TOPUP timestamp: '2026-03-01T12:00:00.000Z' summary: Budget increased pagination: page: 1 pageSize: 20 totalCount: 3 totalPages: 1 meta: requestId: 550e8400-e29b-41d4-a716-446655440000 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' security: - apiKeyBearerAuth: [] - oauthBearer: [] components: parameters: campaignId: name: campaignId in: path required: true schema: type: string description: Campaign identifier (UUID) schemas: CampaignActivityResponse: type: object required: - data - meta properties: data: $ref: '#/components/schemas/CampaignActivityData' meta: $ref: '#/components/schemas/Meta' CampaignActivityData: type: object required: - items - pagination properties: items: type: array items: $ref: '#/components/schemas/CampaignActivityItem' pagination: $ref: '#/components/schemas/Pagination' Meta: type: object required: - requestId properties: requestId: type: string format: uuid description: Server-generated request ID. Include when contacting support. ErrorResponse: type: object required: - error - meta properties: error: $ref: '#/components/schemas/Error' meta: $ref: '#/components/schemas/Meta' CampaignActivityItem: type: object required: - event_type - timestamp - summary properties: event_type: type: string description: Activity event type. timestamp: type: string format: date-time description: When the event was recorded. summary: type: string description: Short description. Omits fees, payment ids, and file URIs. Pagination: type: object required: - page - pageSize - totalCount - totalPages properties: page: type: integer pageSize: type: integer totalCount: type: integer totalPages: type: integer Error: type: object required: - code - message properties: code: type: string description: Stable snake_case error code. enum: - invalid_api_key - invalid_token - api_key_revoked - api_key_expired - access_denied - insufficient_scope - not_found - not_in_listening_graph - campaign_not_found - invalid_query_parameter - invalid_date_range - page_size_exceeded - invalid_request - invalid_genre - invalid_duration_or_budget - invalid_daily_budget - invalid_duration_days - invalid_spotify_url - invalid_tier_budget_allocation - invalid_tier_status - learning_edit_ack_required - wallet_not_enabled - premium_plan_required - soundlink_plan_required - custom_pixel_not_enabled - meta_pixel_conflict - pixel_in_use - insufficient_credit - idempotency_key_conflict - rate_limit_exceeded - invalid_video_url - video_import_limit_exceeded - video_import_session_not_found - internal_error message: type: string description: Human-readable error description. Do not parse programmatically. details: type: object nullable: true description: | Additive, error-code-specific context (e.g. `available`/`required` on `insufficient_credit`). Absent or `null` for error codes that carry no extra data. additionalProperties: true responses: BadRequest: description: Invalid query parameter or date range content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: invalid_query_parameter: value: error: code: invalid_query_parameter message: pageSize must be an integer between 1 and 500. meta: requestId: 550e8400-e29b-41d4-a716-446655440000 invalid_date_range: value: error: code: invalid_date_range message: endDate must not be before startDate. meta: requestId: 550e8400-e29b-41d4-a716-446655440000 Unauthorized: description: | Missing or invalid credentials. Covers missing/malformed API keys, invalid or expired OAuth access tokens, and revoked API keys. `x-api-key` is not accepted and is ignored if sent. headers: Retry-After: schema: type: integer description: Present only on `rate_limit_exceeded` content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: invalid_api_key: value: error: code: invalid_api_key message: 'Missing credentials. Send Authorization: Bearer.' meta: requestId: 550e8400-e29b-41d4-a716-446655440000 invalid_token: value: error: code: invalid_token message: OAuth access token is invalid or expired. meta: requestId: 550e8400-e29b-41d4-a716-446655440000 api_key_revoked: value: error: code: api_key_revoked message: >- This API key has been revoked. Create a new key in Settings → Developer → API keys. meta: requestId: 550e8400-e29b-41d4-a716-446655440000 Forbidden: description: | Authenticated but not allowed: missing required scope, or OAuth access disabled for the organization (`access_denied`). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: insufficient_scope: value: error: code: insufficient_scope message: This token does not have the metrics:read scope. meta: requestId: 550e8400-e29b-41d4-a716-446655440000 access_denied: value: error: code: access_denied message: OAuth access is not enabled for this organization. meta: requestId: 550e8400-e29b-41d4-a716-446655440000 NotFound: description: Campaign not found or belongs to another organization content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: campaign_not_found message: Campaign not found. meta: requestId: 550e8400-e29b-41d4-a716-446655440000 RateLimited: description: Per-key rate limit exceeded (60/min, 600/hr) headers: Retry-After: required: true schema: type: integer description: Seconds until the rate limit resets content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: rate_limit_exceeded message: >- Rate limit exceeded. Retry after the number of seconds indicated in the Retry-After header. meta: requestId: 550e8400-e29b-41d4-a716-446655440000 InternalError: description: Unexpected server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: internal_error message: >- An unexpected error occurred. Contact support with the requestId. meta: requestId: 550e8400-e29b-41d4-a716-446655440000 securitySchemes: apiKeyBearerAuth: type: http scheme: bearer description: | Pass your Soundlink `sk_*` API key as a Bearer token: `Authorization: Bearer sk__` (not an OAuth token; see `oauthBearer` for that). Accepted on all Public API operations. Send only one `Authorization` header per request. oauthBearer: type: http scheme: bearer bearerFormat: JWT description: | OAuth 2.0 access token from Sign in with Soundlink (`Authorization: Bearer `). Token scopes must include the operation's required scope (see `x-required-scope` and the Authentication section). Accepted on all Public API operations (reads and writes). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.