Reports

Results for a period: messages and junk, leads per tier and how many became deals (won rate, revenue), which criteria predict deals, sources and leads per day — and all workspaces side by side for agencies. Leads count on the day they arrived. The console's Reports page and the MCP tools get_report and compare_workspaces use the same numbers.

The Report object

Properties

  • Name
    object
    Type
    'report'
    Description

    The object type.

  • Name
    workspaceId
    Type
    string
    Description

    The workspace this object belongs to.

  • Name
    from
    Type
    string
    Description

     

  • Name
    to
    Type
    string
    Description

     

  • Name
    timezone
    Type
    string
    Description

     

  • Name
    currency
    Type
    string
    Description

    Revenue counts deals won in this currency

  • Name
    totals
    Type
    object
    Description

     

  • Name
    tiers
    Type
    array of object
    Description

    Leads → deals per tier, best tier first

  • Name
    criteria
    Type
    array of object
    Description

    Which criteria predict deals, strongest first

  • Name
    sources
    Type
    array of object
    Description

     

  • Name
    days
    Type
    array of object
    Description

     


GET/v1/reports

Results of a workspace: leads by tier, which tiers and criteria became deals, sources, day by day

Leads are counted by the day they arrived; a deal won later counts for that day too. Revenue sums deals won in the workspace's currency.

Query parameters

  • Name
    from
    Type
    string
    Description

    First day, in the workspace's time zone. Default: 29 days before to

  • Name
    to
    Type
    string
    Description

    Last day, included. Default: today. At most 366 days per report

Request

GET
/v1/reports
curl https://core.leadveyor.com/v1/reports \
  -H "Authorization: Bearer {api_key}" \
  -H "Leadveyor-Workspace: {workspace_id}"  # account-wide keys only

Response 200

{
  "object": "report",
  "workspaceId": "work_9Kx2Lq7Vt4Wz8Nb3Pc6Rd1Hm",
  "from": "from",
  "to": "to",
  "timezone": "timezone",
  "currency": "currency",
  "totals": {
    "inbounds": 0,
    "junk": 0,
    "notLead": 0,
    "leads": 0,
    "won": 0,
    "lost": 0,
    "wonRate": 0,
    "revenue": {
      "amount": 0,
      "currency": "currency"
    }
  },
  "tiers": [
    {
      "tier": "tier",
      "leads": 0,
      "share": 0,
      "avgScore": null,
      "won": 0,
      "lost": 0,
      "otherOutcomes": 0,
      "wonRate": 0,
      "revenue": {
        "amount": 0,
        "currency": "currency"
      }
    }
  ],
  "criteria": [
    {
      "id": "id",
      "label": "label",
      "type": "type",
      "met": {
        "leads": 0,
        "won": 0,
        "wonRate": 0
      },
      "notMet": {
        "leads": 0,
        "won": 0,
        "wonRate": 0
      },
      "lift": null
    }
  ],
  "sources": [
    {
      "sourceId": "sour_9Kx2Lq7Vt4Wz8Nb3Pc6Rd1Hm",
      "name": "name",
      "type": "type",
      "inbounds": 0,
      "junk": 0,
      "leads": 0,
      "tiers": {
        "hot": 12,
        "warm": 30,
        "cold": 41
      },
      "won": 0
    }
  ],
  "days": [
    {
      "date": "date",
      "inbounds": 0,
      "junk": 0,
      "leads": 0,
      "tiers": {
        "hot": 12,
        "warm": 30,
        "cold": 41
      }
    }
  ]
}

GET/v1/reports/workspaces

All workspaces side by side: leads, tiers, deals won and revenue (for agencies)

Query parameters

  • Name
    from
    Type
    string
    Description

    First day, in the workspace's time zone. Default: 29 days before to

  • Name
    to
    Type
    string
    Description

    Last day, included. Default: today. At most 366 days per report

Request

GET
/v1/reports/workspaces
curl https://core.leadveyor.com/v1/reports/workspaces \
  -H "Authorization: Bearer {api_key}"

Response 200

{
  "object": "workspace_comparison",
  "from": null,
  "to": null,
  "data": [
    {
      "workspaceId": "work_9Kx2Lq7Vt4Wz8Nb3Pc6Rd1Hm",
      "name": "name",
      "currency": "currency",
      "inbounds": 0,
      "junk": 0,
      "leads": 0,
      "tiers": {
        "hot": 12,
        "warm": 30,
        "cold": 41
      },
      "won": 0,
      "lost": 0,
      "wonRate": 0,
      "revenue": {
        "amount": 0,
        "currency": "currency"
      }
    }
  ]
}

Was this page helpful?