Gajo · Schema
RoutingOverviewResult
Envelope with a link's routing rules and binding.
URL ShortenersAnalyticsDeveloper Tool
Properties
| Name | Type | Description |
|---|---|---|
| success | object | |
| message | stringnull | Human-readable status or error message. Often `null` on reads. |
| data | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/gajo-io/json-schema/gajo-io-routing-overview-result-schema.json",
"title": "RoutingOverviewResult",
"description": "Envelope with a link's routing rules and binding.",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/gajo-io-routing-rules-api-openapi.yml#/components/schemas/RoutingOverviewResult",
"allOf": [
{
"$ref": "#/$defs/ApiResult"
},
{
"type": "object",
"required": [
"data"
],
"properties": {
"success": {
"const": true
},
"data": {
"$ref": "#/$defs/RoutingOverview"
}
}
}
],
"$defs": {
"ApiResult": {
"type": "object",
"description": "Envelope shared by every response.",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"description": "`true` when the request succeeded."
},
"message": {
"type": [
"string",
"null"
],
"description": "Human-readable status or error message. Often `null` on reads."
},
"data": {
"description": "Operation-specific payload; `null` or absent when there is nothing to return."
}
}
},
"Binding": {
"type": "object",
"description": "A link's template binding. When `bound` is `false`, only `shortCode` and `bound` are returned.",
"required": [
"bound"
],
"properties": {
"shortCode": {
"type": "string"
},
"bound": {
"type": "boolean"
},
"routingType": {
"$ref": "#/$defs/RoutingType",
"description": "`Device` (route template) or `AbTest` (A/B template)."
},
"templateName": {
"type": [
"string",
"null"
],
"description": "Name of the bound route or A/B template, or `null` if it was deleted (the link then uses its original destination)."
},
"routeTemplateId": {
"type": [
"integer",
"null"
],
"description": "Numeric ID of the bound route template (`null` for A/B bindings). Deprecated: use `templateName`.",
"deprecated": true
},
"abTemplateId": {
"type": [
"integer",
"null"
],
"description": "Numeric ID of the bound A/B template (`null` for Device bindings). Deprecated: use `templateName`.",
"deprecated": true
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"endpoints": {
"type": "array",
"items": {
"$ref": "#/$defs/Endpoint"
}
}
}
},
"DeviceClass": {
"type": "string",
"enum": [
"Mobile",
"Tablet",
"Desktop"
],
"description": "Device class for per-URL `Device` rules."
},
"Endpoint": {
"type": "object",
"description": "A concrete destination for one slot of a binding.",
"required": [
"slotKey",
"targetType",
"targetUrl",
"fallbackUrl",
"routeTemplateName",
"routeTemplateId",
"endpointName"
],
"properties": {
"slotKey": {
"type": "string",
"description": "Device slot (Device bindings) or variant name (A/B bindings)."
},
"targetType": {
"$ref": "#/$defs/EndpointTarget"
},
"targetUrl": {
"type": [
"string",
"null"
]
},
"fallbackUrl": {
"type": [
"string",
"null"
],
"description": "Web fallback when `targetUrl` is an app deep link and the app is not installed."
},
"routeTemplateName": {
"type": [
"string",
"null"
],
"description": "Name of the chained route template when `targetType` is `RouteTemplate` (`null` otherwise, or if it was deleted)."
},
"routeTemplateId": {
"type": [
"integer",
"null"
],
"description": "Numeric ID of the chained route template when `targetType` is `RouteTemplate`. Deprecated: use `routeTemplateName`.",
"deprecated": true
},
"endpointName": {
"type": [
"string",
"null"
],
"description": "Optional label."
}
}
},
"EndpointTarget": {
"type": "string",
"enum": [
"Url",
"RouteTemplate"
],
"description": "`Url` (default) sends the slot to `targetUrl`. `RouteTemplate` is reserved for chaining an A/B variant to a route template; this is not fully supported yet, so use `Url` targets."
},
"RoutingOverview": {
"type": "object",
"required": [
"shortCode",
"rules",
"binding"
],
"properties": {
"shortCode": {
"type": "string"
},
"rules": {
"type": "array",
"items": {
"$ref": "#/$defs/RoutingRule"
},
"description": "Per-URL rules, ordered by priority."
},
"binding": {
"oneOf": [
{
"$ref": "#/$defs/Binding"
},
{
"type": "null"
}
],
"description": "The link's active template binding, or `null` when it has none. A binding takes precedence over per-URL rules."
}
}
},
"RoutingRule": {
"type": "object",
"required": [
"id",
"ruleType",
"priority",
"active",
"deviceType",
"targetUrl",
"variantName",
"splitPercentage",
"createdDate"
],
"properties": {
"id": {
"type": "integer",
"description": "Rule ID, used by `PUT`/`DELETE /urls/{code}/routing/{ruleId}`."
},
"ruleType": {
"$ref": "#/$defs/RoutingType"
},
"priority": {
"type": "integer",
"minimum": 0,
"description": "Position within the batch the rule was created in (0-based)."
},
"active": {
"type": "boolean"
},
"deviceType": {
"oneOf": [
{
"$ref": "#/$defs/DeviceClass"
},
{
"type": "null"
}
],
"description": "Set on `Device` rules; `null` on `AbTest` rules."
},
"targetUrl": {
"type": "string",
"description": "Destination for matching clicks."
},
"variantName": {
"type": [
"string",
"null"
],
"description": "Set on `AbTest` rules."
},
"splitPercentage": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 100,
"description": "Set on `AbTest` rules."
},
"createdDate": {
"type": "string",
"format": "date-time"
}
}
},
"RoutingType": {
"type": "string",
"enum": [
"Device",
"AbTest"
],
"description": "`Device` routes by device class; `AbTest` splits traffic by percentage."
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/gajo-io-routing-overview-result"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.