Get Developer Operational Analytics
/api/v1/developer/analytics/operationsUse the access scope below. The generated schemas specify the exact request and responses.
Access scopeanalytics.operations.read
Authorization: Bearer YOUR_PROJECT_TOKEN
Parameters
periodDaysoptional · querynumberdefault: 30JSON Schema
{ "type": "number", "default": 30 }
Request examples
curl --request GET 'https://YOUR_NOVA_HOST/api/v1/developer/analytics/operations?periodDays=30' --header 'Authorization: Bearer YOUR_PROJECT_TOKEN'
Responses
200 Aggregate operational analytics
application/jsonobject
periodDaysrequired- union
Nested schema
unionVariant 1
numberenum: [7]JSON Schema
{ "type": "number", "enum": [ 7 ] }Variant 2
numberenum: [30]JSON Schema
{ "type": "number", "enum": [ 30 ] }Variant 3
numberenum: [90]JSON Schema
{ "type": "number", "enum": [ 90 ] }JSON Schema
{ "anyOf": [ { "type": "number", "enum": [ 7 ] }, { "type": "number", "enum": [ 30 ] }, { "type": "number", "enum": [ 90 ] } ] } timeZonerequired- stringminLength: 1 · maxLength: 100
windowrequired- object
Nested schema
objectfromrequired- stringformat: "date-time"
torequired- stringformat: "date-time"
JSON Schema
{ "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" } }, "required": [ "from", "to" ], "additionalProperties": false } generatedAtrequired- stringformat: "date-time"
projectedThroughrequired- string | nullformat: "date-time"
summaryrequired- object
Nested schema
objectincomingMessagesrequired- integerminimum: 0
activeConversationsrequired- integerminimum: 0
operatorRepliesrequired- integerminimum: 0
sentRepliesrequired- integerminimum: 0
failedRepliesrequired- integerminimum: 0
pendingRepliesrequired- integerminimum: 0
terminalDeliveriesrequired- integerminimum: 0
deliverySuccessRaterequired- number | nullminimum: 0 · maximum: 1
createdDealsrequired- integerminimum: 0
openDealsrequired- integerminimum: 0
wonDealsrequired- integerminimum: 0
lostDealsrequired- integerminimum: 0
dealConversionRaterequired- number | nullminimum: 0 · maximum: 1
JSON Schema
{ "type": "object", "properties": { "incomingMessages": { "type": "integer", "minimum": 0 }, "activeConversations": { "type": "integer", "minimum": 0 }, "operatorReplies": { "type": "integer", "minimum": 0 }, "sentReplies": { "type": "integer", "minimum": 0 }, "failedReplies": { "type": "integer", "minimum": 0 }, "pendingReplies": { "type": "integer", "minimum": 0 }, "terminalDeliveries": { "type": "integer", "minimum": 0 }, "deliverySuccessRate": { "type": [ "number", "null" ], "minimum": 0, "maximum": 1 }, "createdDeals": { "type": "integer", "minimum": 0 }, "openDeals": { "type": "integer", "minimum": 0 }, "wonDeals": { "type": "integer", "minimum": 0 }, "lostDeals": { "type": "integer", "minimum": 0 }, "dealConversionRate": { "type": [ "number", "null" ], "minimum": 0, "maximum": 1 } }, "required": [ "incomingMessages", "activeConversations", "operatorReplies", "sentReplies", "failedReplies", "pendingReplies", "terminalDeliveries", "deliverySuccessRate", "createdDeals", "openDeals", "wonDeals", "lostDeals", "dealConversionRate" ], "additionalProperties": false } comparisonrequired- object | null
Nested schema
object | nullwindowrequired- object
Nested schema
objectfromrequired- stringformat: "date-time"
torequired- stringformat: "date-time"
JSON Schema
{ "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" } }, "required": [ "from", "to" ], "additionalProperties": false } previousSummaryrequired- object
Nested schema
objectincomingMessagesrequired- integerminimum: 0
activeConversationsrequired- integerminimum: 0
operatorRepliesrequired- integerminimum: 0
sentRepliesrequired- integerminimum: 0
failedRepliesrequired- integerminimum: 0
pendingRepliesrequired- integerminimum: 0
terminalDeliveriesrequired- integerminimum: 0
deliverySuccessRaterequired- number | nullminimum: 0 · maximum: 1
createdDealsrequired- integerminimum: 0
openDealsrequired- integerminimum: 0
wonDealsrequired- integerminimum: 0
lostDealsrequired- integerminimum: 0
dealConversionRaterequired- number | nullminimum: 0 · maximum: 1
JSON Schema
{ "type": "object", "properties": { "incomingMessages": { "type": "integer", "minimum": 0 }, "activeConversations": { "type": "integer", "minimum": 0 }, "operatorReplies": { "type": "integer", "minimum": 0 }, "sentReplies": { "type": "integer", "minimum": 0 }, "failedReplies": { "type": "integer", "minimum": 0 }, "pendingReplies": { "type": "integer", "minimum": 0 }, "terminalDeliveries": { "type": "integer", "minimum": 0 }, "deliverySuccessRate": { "type": [ "number", "null" ], "minimum": 0, "maximum": 1 }, "createdDeals": { "type": "integer", "minimum": 0 }, "openDeals": { "type": "integer", "minimum": 0 }, "wonDeals": { "type": "integer", "minimum": 0 }, "lostDeals": { "type": "integer", "minimum": 0 }, "dealConversionRate": { "type": [ "number", "null" ], "minimum": 0, "maximum": 1 } }, "required": [ "incomingMessages", "activeConversations", "operatorReplies", "sentReplies", "failedReplies", "pendingReplies", "terminalDeliveries", "deliverySuccessRate", "createdDeals", "openDeals", "wonDeals", "lostDeals", "dealConversionRate" ], "additionalProperties": false } metricsrequired- object
Nested schema
objectincomingMessagesrequired- object
Nested schema
objectcurrentrequired- number | null
previousrequired- number | null
absoluteChangerequired- number | null
relativeChangerequired- number | null
directionrequired- stringenum: ["increased","decreased","unchanged","unavailable"]
JSON Schema
{ "type": "object", "properties": { "current": { "type": [ "number", "null" ] }, "previous": { "type": [ "number", "null" ] }, "absoluteChange": { "type": [ "number", "null" ] }, "relativeChange": { "type": [ "number", "null" ] }, "direction": { "type": "string", "enum": [ "increased", "decreased", "unchanged", "unavailable" ] } }, "required": [ "current", "previous", "absoluteChange", "relativeChange", "direction" ], "additionalProperties": false } operatorRepliesrequired- object
Nested schema
objectcurrentrequired- number | null
previousrequired- number | null
absoluteChangerequired- number | null
relativeChangerequired- number | null
directionrequired- stringenum: ["increased","decreased","unchanged","unavailable"]
JSON Schema
{ "type": "object", "properties": { "current": { "type": [ "number", "null" ] }, "previous": { "type": [ "number", "null" ] }, "absoluteChange": { "type": [ "number", "null" ] }, "relativeChange": { "type": [ "number", "null" ] }, "direction": { "type": "string", "enum": [ "increased", "decreased", "unchanged", "unavailable" ] } }, "required": [ "current", "previous", "absoluteChange", "relativeChange", "direction" ], "additionalProperties": false } deliverySuccessRaterequired- object
Nested schema
objectcurrentrequired- number | null
previousrequired- number | null
absoluteChangerequired- number | null
relativeChangerequired- number | null
directionrequired- stringenum: ["increased","decreased","unchanged","unavailable"]
JSON Schema
{ "type": "object", "properties": { "current": { "type": [ "number", "null" ] }, "previous": { "type": [ "number", "null" ] }, "absoluteChange": { "type": [ "number", "null" ] }, "relativeChange": { "type": [ "number", "null" ] }, "direction": { "type": "string", "enum": [ "increased", "decreased", "unchanged", "unavailable" ] } }, "required": [ "current", "previous", "absoluteChange", "relativeChange", "direction" ], "additionalProperties": false } wonDealsrequired- object
Nested schema
objectcurrentrequired- number | null
previousrequired- number | null
absoluteChangerequired- number | null
relativeChangerequired- number | null
directionrequired- stringenum: ["increased","decreased","unchanged","unavailable"]
JSON Schema
{ "type": "object", "properties": { "current": { "type": [ "number", "null" ] }, "previous": { "type": [ "number", "null" ] }, "absoluteChange": { "type": [ "number", "null" ] }, "relativeChange": { "type": [ "number", "null" ] }, "direction": { "type": "string", "enum": [ "increased", "decreased", "unchanged", "unavailable" ] } }, "required": [ "current", "previous", "absoluteChange", "relativeChange", "direction" ], "additionalProperties": false }
JSON Schema
{ "type": "object", "properties": { "incomingMessages": { "type": "object", "properties": { "current": { "type": [ "number", "null" ] }, "previous": { "type": [ "number", "null" ] }, "absoluteChange": { "type": [ "number", "null" ] }, "relativeChange": { "type": [ "number", "null" ] }, "direction": { "type": "string", "enum": [ "increased", "decreased", "unchanged", "unavailable" ] } }, "required": [ "current", "previous", "absoluteChange", "relativeChange", "direction" ], "additionalProperties": false }, "operatorReplies": { "type": "object", "properties": { "current": { "type": [ "number", "null" ] }, "previous": { "type": [ "number", "null" ] }, "absoluteChange": { "type": [ "number", "null" ] }, "relativeChange": { "type": [ "number", "null" ] }, "direction": { "type": "string", "enum": [ "increased", "decreased", "unchanged", "unavailable" ] } }, "required": [ "current", "previous", "absoluteChange", "relativeChange", "direction" ], "additionalProperties": false }, "deliverySuccessRate": { "type": "object", "properties": { "current": { "type": [ "number", "null" ] }, "previous": { "type": [ "number", "null" ] }, "absoluteChange": { "type": [ "number", "null" ] }, "relativeChange": { "type": [ "number", "null" ] }, "direction": { "type": "string", "enum": [ "increased", "decreased", "unchanged", "unavailable" ] } }, "required": [ "current", "previous", "absoluteChange", "relativeChange", "direction" ], "additionalProperties": false }, "wonDeals": { "type": "object", "properties": { "current": { "type": [ "number", "null" ] }, "previous": { "type": [ "number", "null" ] }, "absoluteChange": { "type": [ "number", "null" ] }, "relativeChange": { "type": [ "number", "null" ] }, "direction": { "type": "string", "enum": [ "increased", "decreased", "unchanged", "unavailable" ] } }, "required": [ "current", "previous", "absoluteChange", "relativeChange", "direction" ], "additionalProperties": false } }, "required": [ "incomingMessages", "operatorReplies", "deliverySuccessRate", "wonDeals" ], "additionalProperties": false }
JSON Schema
{ "type": [ "object", "null" ], "properties": { "window": { "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" } }, "required": [ "from", "to" ], "additionalProperties": false }, "previousSummary": { "type": "object", "properties": { "incomingMessages": { "type": "integer", "minimum": 0 }, "activeConversations": { "type": "integer", "minimum": 0 }, "operatorReplies": { "type": "integer", "minimum": 0 }, "sentReplies": { "type": "integer", "minimum": 0 }, "failedReplies": { "type": "integer", "minimum": 0 }, "pendingReplies": { "type": "integer", "minimum": 0 }, "terminalDeliveries": { "type": "integer", "minimum": 0 }, "deliverySuccessRate": { "type": [ "number", "null" ], "minimum": 0, "maximum": 1 }, "createdDeals": { "type": "integer", "minimum": 0 }, "openDeals": { "type": "integer", "minimum": 0 }, "wonDeals": { "type": "integer", "minimum": 0 }, "lostDeals": { "type": "integer", "minimum": 0 }, "dealConversionRate": { "type": [ "number", "null" ], "minimum": 0, "maximum": 1 } }, "required": [ "incomingMessages", "activeConversations", "operatorReplies", "sentReplies", "failedReplies", "pendingReplies", "terminalDeliveries", "deliverySuccessRate", "createdDeals", "openDeals", "wonDeals", "lostDeals", "dealConversionRate" ], "additionalProperties": false }, "metrics": { "type": "object", "properties": { "incomingMessages": { "type": "object", "properties": { "current": { "type": [ "number", "null" ] }, "previous": { "type": [ "number", "null" ] }, "absoluteChange": { "type": [ "number", "null" ] }, "relativeChange": { "type": [ "number", "null" ] }, "direction": { "type": "string", "enum": [ "increased", "decreased", "unchanged", "unavailable" ] } }, "required": [ "current", "previous", "absoluteChange", "relativeChange", "direction" ], "additionalProperties": false }, "operatorReplies": { "type": "object", "properties": { "current": { "type": [ "number", "null" ] }, "previous": { "type": [ "number", "null" ] }, "absoluteChange": { "type": [ "number", "null" ] }, "relativeChange": { "type": [ "number", "null" ] }, "direction": { "type": "string", "enum": [ "increased", "decreased", "unchanged", "unavailable" ] } }, "required": [ "current", "previous", "absoluteChange", "relativeChange", "direction" ], "additionalProperties": false }, "deliverySuccessRate": { "type": "object", "properties": { "current": { "type": [ "number", "null" ] }, "previous": { "type": [ "number", "null" ] }, "absoluteChange": { "type": [ "number", "null" ] }, "relativeChange": { "type": [ "number", "null" ] }, "direction": { "type": "string", "enum": [ "increased", "decreased", "unchanged", "unavailable" ] } }, "required": [ "current", "previous", "absoluteChange", "relativeChange", "direction" ], "additionalProperties": false }, "wonDeals": { "type": "object", "properties": { "current": { "type": [ "number", "null" ] }, "previous": { "type": [ "number", "null" ] }, "absoluteChange": { "type": [ "number", "null" ] }, "relativeChange": { "type": [ "number", "null" ] }, "direction": { "type": "string", "enum": [ "increased", "decreased", "unchanged", "unavailable" ] } }, "required": [ "current", "previous", "absoluteChange", "relativeChange", "direction" ], "additionalProperties": false } }, "required": [ "incomingMessages", "operatorReplies", "deliverySuccessRate", "wonDeals" ], "additionalProperties": false } }, "required": [ "window", "previousSummary", "metrics" ], "additionalProperties": false } dailyrequired- arraymaxItems: 90
Nested schema
arraymaxItems: 90objectdaterequired- stringformat: "date"
incomingMessagesrequired- integerminimum: 0
operatorRepliesrequired- integerminimum: 0
JSON Schema
{ "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "incomingMessages": { "type": "integer", "minimum": 0 }, "operatorReplies": { "type": "integer", "minimum": 0 } }, "required": [ "date", "incomingMessages", "operatorReplies" ], "additionalProperties": false }JSON Schema
{ "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "incomingMessages": { "type": "integer", "minimum": 0 }, "operatorReplies": { "type": "integer", "minimum": 0 } }, "required": [ "date", "incomingMessages", "operatorReplies" ], "additionalProperties": false }, "maxItems": 90 } channelsrequired- arraymaxItems: 100
Nested schema
arraymaxItems: 100objectproviderTyperequired- stringminLength: 1 · maxLength: 80
incomingMessagesrequired- integerminimum: 0
sharerequired- numberminimum: 0 · maximum: 1
JSON Schema
{ "type": "object", "properties": { "providerType": { "type": "string", "minLength": 1, "maxLength": 80 }, "incomingMessages": { "type": "integer", "minimum": 0 }, "share": { "type": "number", "minimum": 0, "maximum": 1 } }, "required": [ "providerType", "incomingMessages", "share" ], "additionalProperties": false }JSON Schema
{ "type": "array", "items": { "type": "object", "properties": { "providerType": { "type": "string", "minLength": 1, "maxLength": 80 }, "incomingMessages": { "type": "integer", "minimum": 0 }, "share": { "type": "number", "minimum": 0, "maximum": 1 } }, "required": [ "providerType", "incomingMessages", "share" ], "additionalProperties": false }, "maxItems": 100 }
JSON Schema
{
"type": "object",
"properties": {
"periodDays": {
"anyOf": [
{
"type": "number",
"enum": [
7
]
},
{
"type": "number",
"enum": [
30
]
},
{
"type": "number",
"enum": [
90
]
}
]
},
"timeZone": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"window": {
"type": "object",
"properties": {
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
},
"required": [
"from",
"to"
],
"additionalProperties": false
},
"generatedAt": {
"type": "string",
"format": "date-time"
},
"projectedThrough": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"summary": {
"type": "object",
"properties": {
"incomingMessages": {
"type": "integer",
"minimum": 0
},
"activeConversations": {
"type": "integer",
"minimum": 0
},
"operatorReplies": {
"type": "integer",
"minimum": 0
},
"sentReplies": {
"type": "integer",
"minimum": 0
},
"failedReplies": {
"type": "integer",
"minimum": 0
},
"pendingReplies": {
"type": "integer",
"minimum": 0
},
"terminalDeliveries": {
"type": "integer",
"minimum": 0
},
"deliverySuccessRate": {
"type": [
"number",
"null"
],
"minimum": 0,
"maximum": 1
},
"createdDeals": {
"type": "integer",
"minimum": 0
},
"openDeals": {
"type": "integer",
"minimum": 0
},
"wonDeals": {
"type": "integer",
"minimum": 0
},
"lostDeals": {
"type": "integer",
"minimum": 0
},
"dealConversionRate": {
"type": [
"number",
"null"
],
"minimum": 0,
"maximum": 1
}
},
"required": [
"incomingMessages",
"activeConversations",
"operatorReplies",
"sentReplies",
"failedReplies",
"pendingReplies",
"terminalDeliveries",
"deliverySuccessRate",
"createdDeals",
"openDeals",
"wonDeals",
"lostDeals",
"dealConversionRate"
],
"additionalProperties": false
},
"comparison": {
"type": [
"object",
"null"
],
"properties": {
"window": {
"type": "object",
"properties": {
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
},
"required": [
"from",
"to"
],
"additionalProperties": false
},
"previousSummary": {
"type": "object",
"properties": {
"incomingMessages": {
"type": "integer",
"minimum": 0
},
"activeConversations": {
"type": "integer",
"minimum": 0
},
"operatorReplies": {
"type": "integer",
"minimum": 0
},
"sentReplies": {
"type": "integer",
"minimum": 0
},
"failedReplies": {
"type": "integer",
"minimum": 0
},
"pendingReplies": {
"type": "integer",
"minimum": 0
},
"terminalDeliveries": {
"type": "integer",
"minimum": 0
},
"deliverySuccessRate": {
"type": [
"number",
"null"
],
"minimum": 0,
"maximum": 1
},
"createdDeals": {
"type": "integer",
"minimum": 0
},
"openDeals": {
"type": "integer",
"minimum": 0
},
"wonDeals": {
"type": "integer",
"minimum": 0
},
"lostDeals": {
"type": "integer",
"minimum": 0
},
"dealConversionRate": {
"type": [
"number",
"null"
],
"minimum": 0,
"maximum": 1
}
},
"required": [
"incomingMessages",
"activeConversations",
"operatorReplies",
"sentReplies",
"failedReplies",
"pendingReplies",
"terminalDeliveries",
"deliverySuccessRate",
"createdDeals",
"openDeals",
"wonDeals",
"lostDeals",
"dealConversionRate"
],
"additionalProperties": false
},
"metrics": {
"type": "object",
"properties": {
"incomingMessages": {
"type": "object",
"properties": {
"current": {
"type": [
"number",
"null"
]
},
"previous": {
"type": [
"number",
"null"
]
},
"absoluteChange": {
"type": [
"number",
"null"
]
},
"relativeChange": {
"type": [
"number",
"null"
]
},
"direction": {
"type": "string",
"enum": [
"increased",
"decreased",
"unchanged",
"unavailable"
]
}
},
"required": [
"current",
"previous",
"absoluteChange",
"relativeChange",
"direction"
],
"additionalProperties": false
},
"operatorReplies": {
"type": "object",
"properties": {
"current": {
"type": [
"number",
"null"
]
},
"previous": {
"type": [
"number",
"null"
]
},
"absoluteChange": {
"type": [
"number",
"null"
]
},
"relativeChange": {
"type": [
"number",
"null"
]
},
"direction": {
"type": "string",
"enum": [
"increased",
"decreased",
"unchanged",
"unavailable"
]
}
},
"required": [
"current",
"previous",
"absoluteChange",
"relativeChange",
"direction"
],
"additionalProperties": false
},
"deliverySuccessRate": {
"type": "object",
"properties": {
"current": {
"type": [
"number",
"null"
]
},
"previous": {
"type": [
"number",
"null"
]
},
"absoluteChange": {
"type": [
"number",
"null"
]
},
"relativeChange": {
"type": [
"number",
"null"
]
},
"direction": {
"type": "string",
"enum": [
"increased",
"decreased",
"unchanged",
"unavailable"
]
}
},
"required": [
"current",
"previous",
"absoluteChange",
"relativeChange",
"direction"
],
"additionalProperties": false
},
"wonDeals": {
"type": "object",
"properties": {
"current": {
"type": [
"number",
"null"
]
},
"previous": {
"type": [
"number",
"null"
]
},
"absoluteChange": {
"type": [
"number",
"null"
]
},
"relativeChange": {
"type": [
"number",
"null"
]
},
"direction": {
"type": "string",
"enum": [
"increased",
"decreased",
"unchanged",
"unavailable"
]
}
},
"required": [
"current",
"previous",
"absoluteChange",
"relativeChange",
"direction"
],
"additionalProperties": false
}
},
"required": [
"incomingMessages",
"operatorReplies",
"deliverySuccessRate",
"wonDeals"
],
"additionalProperties": false
}
},
"required": [
"window",
"previousSummary",
"metrics"
],
"additionalProperties": false
},
"daily": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date"
},
"incomingMessages": {
"type": "integer",
"minimum": 0
},
"operatorReplies": {
"type": "integer",
"minimum": 0
}
},
"required": [
"date",
"incomingMessages",
"operatorReplies"
],
"additionalProperties": false
},
"maxItems": 90
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"providerType": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"incomingMessages": {
"type": "integer",
"minimum": 0
},
"share": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"providerType",
"incomingMessages",
"share"
],
"additionalProperties": false
},
"maxItems": 100
}
},
"required": [
"periodDays",
"timeZone",
"window",
"generatedAt",
"projectedThrough",
"summary",
"comparison",
"daily",
"channels"
],
"additionalProperties": false,
"$ref": "#/components/schemas/DeveloperOperationalAnalyticsResponse"
}400 Invalid analytics period
application/problem+jsonobject
type- stringformat: "uri" · default: "about:blank"
titlerequired- string
statusrequired- integerminimum: 100 · maximum: 599
detail- string
instance- string
errors- object
JSON Schema
{
"type": "object",
"properties": {
"type": {
"type": "string",
"format": "uri",
"default": "about:blank"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": 100,
"maximum": 599
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"title",
"status"
]
}401 Invalid developer credential
application/problem+jsonobject
type- stringformat: "uri" · default: "about:blank"
titlerequired- string
statusrequired- integerminimum: 100 · maximum: 599
detail- string
instance- string
errors- object
JSON Schema
{
"type": "object",
"properties": {
"type": {
"type": "string",
"format": "uri",
"default": "about:blank"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": 100,
"maximum": 599
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"title",
"status"
]
}403 Operational analytics unavailable
application/problem+jsonobject
type- stringformat: "uri" · default: "about:blank"
titlerequired- string
statusrequired- integerminimum: 100 · maximum: 599
detail- string
instance- string
errors- object
JSON Schema
{
"type": "object",
"properties": {
"type": {
"type": "string",
"format": "uri",
"default": "about:blank"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": 100,
"maximum": 599
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"title",
"status"
]
}429 Developer API rate limit exceeded
application/problem+jsonobject
type- stringformat: "uri" · default: "about:blank"
titlerequired- string
statusrequired- integerminimum: 100 · maximum: 599
detail- string
instance- string
errors- object
JSON Schema
{
"type": "object",
"properties": {
"type": {
"type": "string",
"format": "uri",
"default": "about:blank"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": 100,
"maximum": 599
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"title",
"status"
]
}503 Developer API rate limiter unavailable
application/problem+jsonobject
type- stringformat: "uri" · default: "about:blank"
titlerequired- string
statusrequired- integerminimum: 100 · maximum: 599
detail- string
instance- string
errors- object
JSON Schema
{
"type": "object",
"properties": {
"type": {
"type": "string",
"format": "uri",
"default": "about:blank"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": 100,
"maximum": 599
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"title",
"status"
]
}