The home page numbers: leads today and this week, first reply, top sources

GET

/v1/reports/home

const url = 'https://api.threadkite.app/v1/reports/home';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.threadkite.app/v1/reports/home \
  --header 'Authorization: Bearer <token>'

The last 7 days, today included, in the inboxes you can see. On every plan.

Authorizations

api_key
reports:read

Responses

200

application/json

object

timeZone

required

string

leadsToday

required

New leads today

number

leadsThisWeek

required

Leads in the last 7 days, today included

number

leadsLastWeek

required

Leads in the 7 days before that

number

medianFirstResponseSeconds

required

Median first response, last 7 days (seconds)

number

nullable

previousMedianFirstResponseSeconds

required

number

nullable

answered

required

Leads answered in the last 7 days

number

withinTarget

required

Of those, answered within target

number

topSources

required

Top five, last 7 days

Array<object>

object

sourceId

required

string format: uuid

nullable

name

required

string

logoUrl

required

string

nullable

leads

required

number

days

required

Each of the last 7 days

Array<object>

object

date

required

string format: date

leads

required

number

medianFirstResponseSeconds

required

number

nullable

Example

{
  "timeZone": "Europe/London"
}

400

Unusable dates or filters

application/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>

object

path

required

Dotted path inside the item, e.g. attributes.price.amountMinor

string

message

required

string

Example

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

401

Missing or invalid API key

application/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>

object

path

required

Dotted path inside the item, e.g. attributes.price.amountMinor

string

message

required

string

Example

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

402

The organisation is on the Free plan (code upgrade_required)

application/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

feature

required

The feature that needs Pro

string

nullable

Allowed values: extraSeats connections aiAssistant aiReplies rules fullReports api inboxes bulkMessages videoMessages

upgradePath

required

Where to upgrade or pay, in the web app

string

Example

{
  "statusCode": 402,
  "code": "upgrade_required",
  "message": "Connections are part of Pro. Upgrade to connect texts, calls and more.",
  "feature": "extraSeats",
  "upgradePath": "/settings/billing"
}

403

The key does not have the scope (or the person the permission)

application/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>

object

path

required

Dotted path inside the item, e.g. attributes.price.amountMinor

string

message

required

string

Example

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

429

Rate limit reached

application/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

retryAfter

required

Seconds until another request will be accepted

number

Example

{
  "statusCode": 429,
  "code": "rate_limited",
  "message": "Too many requests. Each key can make 120 requests a minute; try again in 12 seconds.",
  "retryAfter": 12
}