Viso.li

Campaign Status

GEThttps://www.viso.li/api/campaign/:id/status

Returns how close a campaign is to its goal, plus the stored templateKey and typed goal.config.

Progress uses the campaign date window when dates are set, otherwise all clicks on the attached links.

Send Authorization: Bearer sk_api_your_api_key on every request. See authentication.

Path parameters

FieldTypeDescription
idstringRequired. The campaign UUID.

Example request

1curl https://www.viso.li/api/campaign/3f1c0c2a-7b4e-4d91-9c2a-1b8e6f0d2a11/status \
2 -H "Authorization: Bearer sk_api_your_api_key"

Success response

Returns 200 OK. goal.config is typed by goal.type and keeps template fields such as windowDays or burstDays.

response.json
1{
2 "id": "3f1c0c2a-7b4e-4d91-9c2a-1b8e6f0d2a11",
3 "name": "Bio link",
4 "status": "ACTIVE",
5 "templateKey": "bio-evergreen",
6 "goal": {
7 "type": "CLICKS",
8 "config": {
9 "target": 10000,
10 "windowDays": 30
11 }
12 },
13 "progress": {
14 "type": "CLICKS",
15 "target": 10000,
16 "current": 1240,
17 "remaining": 8760,
18 "percent": 12,
19 "reached": false
20 }
21}

Response fields

FieldTypeDescription
idstringRequired. Campaign UUID.
namestringRequired. Campaign name.
statusstringRequired. ACTIVE, DRAFT, or ENDED.
templateKeystring | nullRequired. Stored template key, or null.
goalobject | nullRequired.
progressobject | nullRequired. Current vs target, when the goal is numeric.

Errors

StatusErrorDescription
400Bad RequestThe campaign id is not a valid UUID.
401UnauthorizedMissing, malformed, or invalid Bearer token.
403ForbiddenCampaigns are not available on the current plan.
404Not FoundNo campaign with that id belongs to you.
429Too Many RequestsMore than 10 requests per minute and 50 requests per day. Some responses include a Retry-After header.
500Internal Server ErrorUnexpected server error. Retry the request.