Skip to content
campaign

Download the latest non-PII Signals dump

GET
/v1/campaign/dump
curl --request GET \
--url https://aggregator.example.com/v1/campaign/dump \
--header 'Authorization: Bearer <token>'

Returns a short-lived pre-signed URL for each of the three objects in the latest non-PII Signals snapshot (user, items, item_actions), so the caller needs no S3 credentials. Each URL expires after CAMPAIGN_DUMP_URL_TTL_SECONDS (default 600s); fetch promptly rather than caching it. Requires the campaign-manager SYSTEM token (client_credentials grant); a coordinator token is rejected. Whole-network and not org-scoped. The exporter overwrites the three objects in place with no cross-object atomicity, so each file carries its own last_modified: a caller that lands mid-run will see them disagree, meaning the snapshot is torn — treat it as such and re-fetch. Returns all three files or an error, never a partial list.

Default Response

Media typeapplication/json
object
network
required
string
instance
required
string
expires_at
required
string
files
required
Array<object>
object
table
required
string
key
required
string
size_bytes
required
integer
last_modified
required
string
nullable
url
required
string
Examplegenerated
{
"network": "example",
"instance": "example",
"expires_at": "example",
"files": [
{
"table": "example",
"key": "example",
"size_bytes": 1,
"last_modified": "example",
"url": "example"
}
]
}

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
"error": {
"code": "example",
"title": "example",
"detail": "example",
"docs": "example",
"fields": {
"additionalProperty": "example"
},
"requestId": "example",
"timestamp": "example"
}
}

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
"error": {
"code": "example",
"title": "example",
"detail": "example",
"docs": "example",
"fields": {
"additionalProperty": "example"
},
"requestId": "example",
"timestamp": "example"
}
}

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
"error": {
"code": "example",
"title": "example",
"detail": "example",
"docs": "example",
"fields": {
"additionalProperty": "example"
},
"requestId": "example",
"timestamp": "example"
}
}

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
"error": {
"code": "example",
"title": "example",
"detail": "example",
"docs": "example",
"fields": {
"additionalProperty": "example"
},
"requestId": "example",
"timestamp": "example"
}
}