Start
Guides
Concepts
API endpoints
GET
Get top redirect rules analytics
https://linkshift.app/api/v1/redirect-rules/analyticsReturns aggregated hit statistics for rules within the selected time window.
Operation ID:
getRedirectRuleAnalyticsTags: Redirect RulesSecurity
- ApiKeyAuth: apiKey | header:X-API-Key | API key generated in LinkShift dashboard (`Organization -> Manage API keys`).
Parameters
Query parameters
end
Type: stringDescription: Exclusive end of analytics window (ISO-8601 UTC datetime).
limit
Type: integerDescription: Number of top rules returned in analytics results.
range
Type: stringDescription: Predefined analytics range (used when start/end are not provided).
start
Type: stringDescription: Inclusive start of analytics window (ISO-8601 UTC datetime).
Request body schema
No request body schema.
Response schema
Analytics payload
Content type:
application/jsonresponse 200objectrequired
Aggregated rule-level traffic analytics.
dataarray of objectrequired
Per-rule analytics entries.
hitsintegerrequired
Total matched hits in selected range.
ruleobjectrequired
Redirect rule resolved during request matching.
blockedAtstring | nullnullable
Timestamp when the rule was blocked.
createdAtstringrequired
Creation timestamp (UTC).
deletedAtstring | nullnullable
Soft-delete timestamp in UTC when deleted.
destinationstring | nullnullable
Static redirect destination URL. Null when dynamic destination is used via link map.
domainGroupIdstringrequired
Parent domain-group ID.
idstringrequired
Redirect-rule ID.
isBlockedboolean
Whether the rule is currently blocked from execution.
linkMapIdstring | nullnullable
Optional linked map used for key-based destinations.
matchMethodarray of stringrequired
Allowed request methods. Empty array means all methods.
pathMatchstringrequired
Path matching strategy.
priorityintegerrequired
Rule priority (higher first).
queryMatchstringrequired
Query-string matching strategy.
sourcestringrequired
Source matcher expression.
statusCodeintegerrequired
HTTP redirect status returned for matches.
updatedAtstringrequired
Last update timestamp (UTC).
topLinkMapKeysarray of objectrequired
Most frequent link-map keys matched by this rule.
hitsintegerrequired
Number of hits for this key.
keystringrequired
Resolved link-map key.
topRequestVariantsarray of objectrequired
Most frequent request variant signatures for this rule.
destinationstringrequired
Destination URL returned by matching.
hitsintegerrequired
Hit count for this variant.
linkMapKeystring | nullnullable
Link-map key used in resolution when applicable.
requestMethodstringrequired
Request method.
requestPathstringrequired
Request path.
requestQuerystringrequired
Request query string.
requestUrlstringrequired
Full normalized request URL.