DEVELOPER PLATFORM · v1

API, с которым удобно работать

CRM, кампании, аналитика и интеграции. Точные контракты, понятные примеры и подписанные вебхуки.

Private preview: API доступен с проектным ключом. Публичные SLA и сроки поддержки ещё не установлены.

GET

Операционная аналитика проекта

/api/v1/developer/analytics/operations

Возвращает агрегаты сообщений, доставки и сделок за 7, 30 или 90 дней с временным окном и свежестью проекции; без project, plan, customer, message или staff workload facts.

Право доступаanalytics.operations.read

Authorization: Bearer YOUR_PROJECT_TOKEN

Параметры

periodDaysнеобязательно · query: numberdefault: 30
JSON Schema
{ "type": "number", "default": 30 }

Примеры запроса

curl --request GET   'https://YOUR_NOVA_HOST/api/v1/developer/analytics/operations?periodDays=30'   --header 'Authorization: Bearer YOUR_PROJECT_TOKEN'

Ответы

200 Aggregate operational analytics

application/json

object

periodDaysобязательно

union

Вложенная схема

union

Вариант 1

numberenum: [7]

JSON Schema

{
  "type": "number",
  "enum": [
    7
  ]
}

Вариант 2

numberenum: [30]

JSON Schema

{
  "type": "number",
  "enum": [
    30
  ]
}

Вариант 3

numberenum: [90]

JSON Schema

{
  "type": "number",
  "enum": [
    90
  ]
}

JSON Schema

{
  "anyOf": [
    {
      "type": "number",
      "enum": [
        7
      ]
    },
    {
      "type": "number",
      "enum": [
        30
      ]
    },
    {
      "type": "number",
      "enum": [
        90
      ]
    }
  ]
}

timeZoneобязательно

stringminLength: 1 · maxLength: 100

windowобязательно

object

Вложенная схема

object

fromобязательно: stringformat: "date-time"
toобязательно: 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
}

generatedAtобязательно

stringformat: "date-time"

projectedThroughобязательно

string | nullformat: "date-time"

summaryобязательно

object

Вложенная схема

object

incomingMessagesобязательно: integerminimum: 0
activeConversationsобязательно: integerminimum: 0
operatorRepliesобязательно: integerminimum: 0
sentRepliesобязательно: integerminimum: 0
failedRepliesобязательно: integerminimum: 0
pendingRepliesобязательно: integerminimum: 0
terminalDeliveriesобязательно: integerminimum: 0
deliverySuccessRateобязательно: number | nullminimum: 0 · maximum: 1
createdDealsобязательно: integerminimum: 0
openDealsобязательно: integerminimum: 0
wonDealsобязательно: integerminimum: 0
lostDealsобязательно: integerminimum: 0
dealConversionRateобязательно: 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
}

comparisonобязательно

object | null

Вложенная схема

object | null

windowобязательно

object

Вложенная схема

object

fromобязательно: stringformat: "date-time"
toобязательно: 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
}

previousSummaryобязательно

object

Вложенная схема

object

incomingMessagesобязательно: integerminimum: 0
activeConversationsобязательно: integerminimum: 0
operatorRepliesобязательно: integerminimum: 0
sentRepliesобязательно: integerminimum: 0
failedRepliesобязательно: integerminimum: 0
pendingRepliesобязательно: integerminimum: 0
terminalDeliveriesобязательно: integerminimum: 0
deliverySuccessRateобязательно: number | nullminimum: 0 · maximum: 1
createdDealsобязательно: integerminimum: 0
openDealsобязательно: integerminimum: 0
wonDealsобязательно: integerminimum: 0
lostDealsобязательно: integerminimum: 0
dealConversionRateобязательно: 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
}

metricsобязательно

object

Вложенная схема

object

incomingMessagesобязательно

object

Вложенная схема

object

currentобязательно: number | null
previousобязательно: number | null
absoluteChangeобязательно: number | null
relativeChangeобязательно: number | null
directionобязательно: 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
}

operatorRepliesобязательно

object

Вложенная схема

object

currentобязательно: number | null
previousобязательно: number | null
absoluteChangeобязательно: number | null
relativeChangeобязательно: number | null
directionобязательно: 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
}

deliverySuccessRateобязательно

object

Вложенная схема

object

currentобязательно: number | null
previousобязательно: number | null
absoluteChangeобязательно: number | null
relativeChangeобязательно: number | null
directionобязательно: 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
}

wonDealsобязательно

object

Вложенная схема

object

currentобязательно: number | null
previousобязательно: number | null
absoluteChangeобязательно: number | null
relativeChangeобязательно: number | null
directionобязательно: 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
}

dailyобязательно

arraymaxItems: 90

Вложенная схема

arraymaxItems: 90

object

dateобязательно: stringformat: "date"
incomingMessagesобязательно: integerminimum: 0
operatorRepliesобязательно: 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
}

channelsобязательно

arraymaxItems: 100

Вложенная схема

arraymaxItems: 100

object

providerTypeобязательно: stringminLength: 1 · maxLength: 80
incomingMessagesобязательно: integerminimum: 0
shareобязательно: 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+json

object

type: stringformat: "uri" · default: "about:blank"
titleобязательно: string
statusобязательно: 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+json

object

type: stringformat: "uri" · default: "about:blank"
titleобязательно: string
statusобязательно: 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+json

object

type: stringformat: "uri" · default: "about:blank"
titleобязательно: string
statusобязательно: 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+json

object

type: stringformat: "uri" · default: "about:blank"
titleобязательно: string
statusобязательно: 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+json

object

type: stringformat: "uri" · default: "about:blank"
titleобязательно: string
statusобязательно: 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"
  ]
}