Leads, sales and cost per lead by campaign, and leads by traffic channel

GET

/v1/reports/campaigns

const url = 'https://api.threadkite.app/v1/reports/campaigns?preset=today&granularity=day&inboxType=sales&sourceCategory=website&channel=email&trafficChannel=paid_search&touch=first';
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/campaigns?preset=today&granularity=day&inboxType=sales&sourceCategory=website&channel=email&trafficChannel=paid_search&touch=first' \
  --header 'Authorization: Bearer <token>'

Each lead’s campaign is the one its visit came from (its utm_campaign, or its lead ad’s campaign); each sale is credited to the first or last lead in the look-back (touch), as for sources. Costs use the spend entered per campaign. Only threads you can see. Part of Pro.

Authorizations

api_key
reports:read

Parameters

Query Parameters

preset

Date range in your organisation’s time zone. Defaults to 30d (the last 30 days, today included); custom needs from and to. Dates without a preset are custom.

string

Allowed values: today 7d 30d this_month last_month custom

Date range in your organisation’s time zone. Defaults to 30d (the last 30 days, today included); custom needs from and to. Dates without a preset are custom.

from

First day (custom ranges), YYYY-MM-DD

string format: date

First day (custom ranges), YYYY-MM-DD

Last day, included (custom ranges)

string format: date

Last day, included (custom ranges)

granularity

Group charts over time by day or week. Defaults to days up to 62 days, else weeks

string

Allowed values: day week

Group charts over time by day or week. Defaults to days up to 62 days, else weeks

inboxId

Only this inbox (one you can see)

string format: uuid

Only this inbox (one you can see)

inboxType

Only inboxes of this type

string

Allowed values: sales service parts bodyshop general

Only inboxes of this type

locationId

Only leads at this location

string format: uuid

Only leads at this location

sourceId

Only leads from this source

string format: uuid

Only leads from this source

sourceCategory

Only sources of this kind

string

Allowed values: website marketplace website_provider dms social phone email other

Only sources of this kind

ownerUserId

Only threads this person owns, or unassigned for threads nobody owns

string

>= 1 characters <= 100 characters

Only threads this person owns, or unassigned for threads nobody owns

channel

Only leads on this channel

string

Allowed values: email sms whatsapp chat phone form api marketplace visit messenger instagram internal

Only leads on this channel

campaignId

Only leads from this campaign

string format: uuid

Only leads from this campaign

trafficChannel

Only leads whose visit came this way (paid search, email…)

string

Allowed values: paid_search paid_social display email sms affiliate organic_search organic_social referral direct other

Only leads whose visit came this way (paid search, email…)

touch

Sales, funnel and campaigns reports: credit each sale to the first lead in the look-back (first) or the latest before the sale (last, the default). Source, source type, channel, campaign and traffic channel filters then apply to that lead.

string

Allowed values: first last

Responses

200

application/json

object

range

required

object

from

required

string format: date

required

string format: date

days

required

number

preset

required

string

Allowed values: today 7d 30d this_month last_month custom

timeZone

required

Your organisation’s time zone

string

granularity

required

string

Allowed values: day week

previous

required

The period compared against

object

from

required

string format: date

required

string format: date

days

required

number

limited

required

The Free plan’s basic reports: only leads by source and first response times are filled in; other breakdowns are empty

boolean

touch

required

string

Allowed values: first last

currency

required

string

costsShown

required

Whether costs are worked out: only for people who see every inbox, without inbox, owner or channel filters

boolean

leads

required

Leads in the range

number

previousLeads

required

number

withCampaign

required

Of those, leads with a campaign

number

campaigns

required

Most leads first

Array<object>

object

spendMinor

required

Spend in the range; null when no month in it has spend entered, in minor units of the report’s currency (pence for GBP)

number

nullable

spendComplete

required

Every month the range touches has spend entered

boolean

missingMonths

required

Months in the range with no spend entered (YYYY-MM)

Array<string>

campaignId

required

Null for leads with no campaign

string format: uuid

nullable

name

required

“No campaign” when null

string

platform

required

string

nullable

Allowed values: google microsoft meta tiktok email other

archived

required

boolean

leads

required

Leads from this campaign in the range

number

previousLeads

required

number

firstTouchSales

required

Sales whose first touch was this campaign

number

lastTouchSales

required

Sales whose last touch was this campaign

number

firstTouchValueMinor

required

number

lastTouchValueMinor

required

number

costPerLead

required

Spend per lead; null without spend or leads, or when costs are not shown, in minor units of the report’s currency (pence for GBP)

number

nullable

costPerSale

required

Spend per sale, by the touch the report uses, in minor units of the report’s currency (pence for GBP)

number

nullable

byTrafficChannel

required

Array<object>

object

channel

required

Null: not known

string

nullable

Allowed values: paid_search paid_social display email sms affiliate organic_search organic_social referral direct other

label

required

string

leads

required

number

previousLeads

required

number

sales

required

Sales credited to it, by the touch the report uses

number

Example

{
  "range": {
    "from": "2026-09-06",
    "to": "2026-10-05",
    "days": 30,
    "preset": "today",
    "timeZone": "Europe/London",
    "granularity": "day",
    "previous": {
      "from": "2026-09-06",
      "to": "2026-10-05",
      "days": 30
    }
  },
  "touch": "first",
  "currency": "GBP",
  "campaigns": [
    {
      "missingMonths": [
        "2026-09"
      ],
      "name": "Spring sale",
      "platform": "google"
    }
  ],
  "byTrafficChannel": [
    {
      "channel": "paid_search",
      "label": "Paid search"
    }
  ]
}

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
}