API referenceActivity

Get team activity log

Returns the team activity log for the brand, who changed what and when, over the last days days. Filter by userId or entityId. activities is the cursor-paginated collection (limit, cursor, nextCursor); summary counts the activities of the returned page.

GET
/v1/brands/{brandId}/activity
bearerAuth
headerAuthorizationBearer <token>

An organization API key (koast_sk_…) with the API surface enabled, or an OAuth access token issued by Koast (koast_at_…) whose audience covers this API. REST access requires an active Agency plan.

brandId*integer

The brand the request acts on. Every brand-scoped resource lives under its brand.

accountId?string

Ad account id (e.g. act_1234 on Meta). Required when no single brand is locked in context, get it from listMyAdAccounts.

Length1 <= length
days?number
Range1 <= value <= 90
Default7
userId?number
entityId?string
cursor?string

Opaque cursor from the previous page's nextCursor. Omit for the first page.

limit?integer

Page size.

Range1 <= value <= 100
Default50

Response Body

Get team activity log

application/json
  1. response
summary*

Totals over the activities of this page.

activities*array<>

The paged collection: one entry per change, newest first. Follow nextCursor for the next page.

nextCursor*|

Pass as cursor to read the next page. Null when there is no next page.

[key: string]?unknown
curl -X GET "https://example.com/v1/brands/0/activity" \  -H "Authorization: Bearer koast_sk_..."
{  "summary": {    "days": 0,    "totalEvents": 0,    "groupedActions": 0,    "perUser": {      "property1": 0,      "property2": 0    },    "perEntity": {      "property1": 0,      "property2": 0    },    "property1": null,    "property2": null  },  "activities": [    {      "userId": 0,      "userName": "string",      "entityType": "campaign",      "entityId": "string",      "entityName": "string",      "action": "string",      "when": "string",      "property1": null,      "property2": null    }  ],  "nextCursor": "string",  "property1": null,  "property2": null}

Required scope: read. CLI: koast get-team-activity-log, see Activity commands. Authentication, headers, errors and pagination work the same on every operation. See Conventions.