Campaigns

GET /api/v1/campaigns

List campaigns in your organization.

Request

bash

curl -H "Authorization: Bearer tga_<key>" \
  "https://www.trackagoat.com/api/v1/campaigns?project_id=<uuid>"

Query parameters

Parameter	Type	Default	Description
`project_id`	uuid	—	Filter to a specific project
`search`	string	—	Filter campaigns by name (case-insensitive substring match)
`limit`	number	50	Items per page (max 100)
`cursor`	string	—	Pagination cursor

Response fields

Field	Type	Description
`id`	uuid	Campaign ID
`project_id`	uuid	Project this campaign belongs to
`name`	string	Campaign name
`description`	string \| null	Campaign strategy / agent context
`metadata`	object	Agent-writable structured data
`created_at`

PATCH /api/v1/campaigns/

Update a campaign's readme field.

Body

Field	Type	Description
`readme`	string \| null	Markdown notes. Pass `null` to clear.

Analytics (time-series)

Campaign time-series analytics have moved to the unified endpoint. The new endpoint also supports breakdown by video or creator, multi-granularity buckets, and prior-period comparison.

bash

# Daily new views for a campaign
curl -H "Authorization: Bearer tga_<key>" \
  "https://www.trackagoat.com/api/v1/analytics?entity=campaign&entity_id=<uuid>&metric=views&mode=new&granularity=day"
 
# Monthly cumulative views
curl -H "Authorization: Bearer tga_<key>" \
  "https://www.trackagoat.com/api/v1/analytics?entity=campaign&entity_id=<uuid>&metric=views&mode=cumulative&granularity=month"
 
# Top-10 video breakdown
curl -H "Authorization: Bearer tga_<key>" \
  "https://www.trackagoat.com/api/v1/analytics?entity=campaign&entity_id=<uuid>&metric=views&breakdown=video&top_n=10"
 
# Engagement rate (derived)
curl -H "Authorization: Bearer tga_<key>" \
  "https://www.trackagoat.com/api/v1/analytics?entity=campaign&entity_id=<uuid>&metric=engagement_rate_by_views&mode=rate"
 
# Multi-entity overlay — compare up to 5 campaigns side-by-side
curl

See the Analytics API reference for the full parameter and response documentation.

Removed: GET /api/v1/campaigns/{id}/stats returned 410 Gone as of v1.2. Use GET /api/v1/analytics?entity=campaign&entity_id={id} instead.