idrequired |
string |
The link’s id. |
domainrequired |
string |
The short domain. |
slugrequired |
string |
The back-half after the domain, with its path when it has one (promo/autumn). |
pathrequired |
string |
The path in front of the back-half, lower case; null for a bare name. |
shortUrlrequired |
string |
The whole short link. |
folderrequired |
string |
The code of the folder the link lives in. |
move |
editsrequired |
number (integer) |
The link edits the move uses: 1 when any field changes, else 0. |
fieldsrequired |
array of "utm" | "params" | "domain" | "app" | "qr" | "tags" | "pixels" |
The fields whose values the move changes. |
|
Only on a move’s dry run (`PATCH` with `folder` and `dryRun: true`): what the move would change; nothing was written. |
inheritedrequired |
array of "utm" | "params" | "domain" | "app" | "qr" | "tags" | "pixels" |
The folder’s preset fields the link still follows: a change to the folder’s preset reaches them. Setting a field on the link takes it out; `PATCH` with `inherit: [...]` puts it back. |
titlerequired |
string |
Its name, shown above the back-half and found by the list’s search; null for none. |
noterequired |
string |
A note for the organisation (at most 2000 characters), never shown to visitors and not searched; null for none. |
destinationrequired |
string |
Where it sends visitors. |
opensrequired |
string |
The destination with the link’s UTM tags added: where a visitor lands. |
statusrequired |
"ACTIVE" | "DISABLED" | "EXPIRED" | "DELETED" |
The stored status; DELETED only in a delete’s answer. |
staterequired |
"ACTIVE" | "SCHEDULED" | "EXPIRED" | "DISABLED" | "DELETED" |
What a visitor meets now: ACTIVE, SCHEDULED (not live yet), EXPIRED, DISABLED. |
slugChosenrequired |
boolean |
The back-half was chosen; false when generated. |
tagsrequired |
array of
namerequired |
string |
The tag as typed. |
kindrequired |
"PERSON" | "TEAM" | "CAMPAIGN" | "CHANNEL" | "PRODUCT" | "REGION" | "CUSTOM" |
What the tag names; a bare name is CUSTOM. |
|
The link’s tags. |
utmrequired |
source |
string |
utm_source, added to the destination. |
medium |
string |
utm_medium, added to the destination. |
campaign |
string |
utm_campaign, added to the destination. |
term |
string |
utm_term, added to the destination. |
content |
string |
utm_content, added to the destination. |
|
The UTM tags the redirect adds to the destination; only those set. |
passModerequired |
"FOLLOW" | "PASS" | "NONE" |
Which of the visit’s own parameters pass on beside utm_ ones: FOLLOW its folder’s preset, then its own domain’s default; PASS the ones passClickIds and passNames name; NONE, whatever the domain passes (for a destination that breaks on extra parameters). Left out of a create: PASS when passClickIds or passNames is sent, else the folder’s. |
passClickIdsrequired |
boolean |
With PASS: the ad networks’ click ids (gclid, fbclid, msclkid and the rest) pass from the visit into the destination. |
passNamesrequired |
array of string |
Other names of the visit’s parameters that pass on beside utm_ ones (ref, for one). Never a redirect’s, such as next, url or redirect_uri: those are refused. |
ogTitlerequired |
string |
The preview title unfurlers show; null for none. |
ogDescriptionrequired |
string |
The preview description; null for none. |
ogImagerequired |
string |
The preview image’s address; null for none. |
liveOnrequired |
string (date-time) |
When it starts answering. |
expiresOnrequired |
string (date-time) |
When it expires; null for never. |
endedOnrequired |
string (date-time) |
When it expired or was deleted; null while it has not. |
trashedOnrequired |
string (date-time) |
When it went to the trash (a deleted link that can still be restored, `POST /links/<link>/restore`); null otherwise. |
maxClicksrequired |
number (integer) |
The click budget; null for none. |
clicksrequired |
number (integer) |
Human clicks counted so far (crawlers are counted apart). |
hasPasswordrequired |
boolean |
Visitors must give a password first. |
maskedrequired |
boolean |
The destination is shown under the short link (own domains only). |
trackConversionsrequired |
boolean |
Visitors carry brv_click to the destination. |
publicStatsrequired |
boolean |
Its public stats page is on. |
qrStyledrequired |
boolean |
Its QR code has a saved style. |
healthrequired |
"UNKNOWN" | "HEALTHY" | "BROKEN" |
Whether the destination answers, as the landing probe last found it. |
healthReasonrequired |
string |
Why it is broken ("Not found (404)"); else null. |
flaggedrequired |
boolean |
A reviewer or the safety check flagged the destination. |
threatrequired |
string |
What it was flagged for; null when it is not. |
reviewRequestedOnrequired |
string (date-time) |
When a review of the flag was asked for; null when none was. |
createdByrequired |
string |
Who made it, by name ("Support" for Brevily’s support team); null when the account is gone. |
createdOnrequired |
string (date-time) |
When it was made. |
updatedOnrequired |
string (date-time) |
When it last changed; null when it never has. |
statsrequired |
daysrequired |
number (integer) |
The days covered: 30, or fewer when the plan keeps fewer. |
clicksrequired |
number (integer) |
Clicks over those days. |
visitorsrequired |
number (integer) |
Unique visitors per day, summed. |
qrScansrequired |
number (integer) |
Of the clicks, those from the QR code. |
changerequired |
clicksrequired |
currentrequired |
number (integer) |
This span. |
previousrequired |
number (integer) |
The same span before it. |
|
|
visitorsrequired |
currentrequired |
number (integer) |
This span. |
previousrequired |
number (integer) |
The same span before it. |
|
|
|
On finished days; null when the plan keeps no days before. |
seriesrequired |
array of
dayrequired |
string |
The day, YYYY-MM-DD, in the organisation’s time zone. |
clicksrequired |
number (integer) |
Clicks that day. |
visitorsrequired |
number (integer) |
Unique visitors that day. |
qrrequired |
number (integer) |
QR scans that day. |
|
One entry per day, oldest first. |
countriesrequired |
array of
valuerequired |
string |
A country code, device, browser, system or referrer origin; UNKNOWN or OTHER for the rest. |
clicksrequired |
number (integer) |
Its clicks. |
|
The top countries. |
devicesrequired |
array of
valuerequired |
string |
A country code, device, browser, system or referrer origin; UNKNOWN or OTHER for the rest. |
clicksrequired |
number (integer) |
Its clicks. |
|
The top devices. |
browsersrequired |
array of
valuerequired |
string |
A country code, device, browser, system or referrer origin; UNKNOWN or OTHER for the rest. |
clicksrequired |
number (integer) |
Its clicks. |
|
The top browsers. |
systemsrequired |
array of
valuerequired |
string |
A country code, device, browser, system or referrer origin; UNKNOWN or OTHER for the rest. |
clicksrequired |
number (integer) |
Its clicks. |
|
The top operating systems. |
referrersrequired |
array of
valuerequired |
string |
A country code, device, browser, system or referrer origin; UNKNOWN or OTHER for the rest. |
clicksrequired |
number (integer) |
Its clicks. |
|
The top referrers. |
referrerSourcesrequired |
array of
valuerequired |
string |
A country code, device, browser, system or referrer origin; UNKNOWN or OTHER for the rest. |
clicksrequired |
number (integer) |
Its clicks. |
|
The top apps and sites the clicks came from, as codes (X, FACEBOOK, GMAIL, ANDROID:<package>…; UNKNOWN when none is known). |
insightsrequired |
zonerequired |
string |
The time zone the hours and weekdays are in. |
regionsrequired |
array of
valuerequired |
string |
A country code, device, browser, system or referrer origin; UNKNOWN or OTHER for the rest. |
clicksrequired |
number (integer) |
Its clicks. |
|
The top regions (a plan with GEO_REPORTS). |
citiesrequired |
array of
valuerequired |
string |
A country code, device, browser, system or referrer origin; UNKNOWN or OTHER for the rest. |
clicksrequired |
number (integer) |
Its clicks. |
|
The top cities (a plan with GEO_REPORTS). |
hoursrequired |
array of
valuerequired |
string |
A country code, device, browser, system or referrer origin; UNKNOWN or OTHER for the rest. |
clicksrequired |
number (integer) |
Its clicks. |
|
The top hours of the day (a plan with TIME_REPORTS). |
weekdaysrequired |
array of
valuerequired |
string |
A country code, device, browser, system or referrer origin; UNKNOWN or OTHER for the rest. |
clicksrequired |
number (integer) |
Its clicks. |
|
The top weekdays (a plan with TIME_REPORTS). |
|
Where and when, on a plan with GEO_REPORTS or TIME_REPORTS; else null. |
|
|