Get inbox summary with trend

Returns windowed conversation metrics with prior-period comparison.

GET/v1/inbox/summary

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Query parameters

windowstring

Window period: 7, 30, or mtd

default: "7"

Responses

200OK

closed_pct_changenumber<double> | nullrequired

currentInboxSummaryWindowrequired

Show properties

closedinteger<int64>required

openinteger<int64>required

totalinteger<int64>required

unassignedinteger<int64>required

open_pct_changenumber<double> | nullrequired

previousInboxSummaryWindowrequired

Show properties

closedinteger<int64>required

openinteger<int64>required

totalinteger<int64>required

unassignedinteger<int64>required

total_pct_changenumber<double> | nullrequired

unassigned_pct_changenumber<double> | nullrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/inbox/summary"

const response = await fetch("/v1/inbox/summary", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/inbox/summary",
)

Response

{
  "closed_pct_change": 0,
  "current": {
    "closed": 0,
    "open": 0,
    "total": 0,
    "unassigned": 0
  },
  "open_pct_change": 0,
  "previous": {
    "closed": 0,
    "open": 0,
    "total": 0,
    "unassigned": 0
  },
  "total_pct_change": 0,
  "unassigned_pct_change": 0
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}