Organization

Get the workspace pulse

One-call workspace briefing: every campaign with its lead count, completion, contacted/delivered counts, engagement funnel, automatically classified positive replies, meetings, deduplicated CRM deal milestones, and unsubscribes over the window (default 7 days), plus the mailbox fleet and account deliverability headline. THE first read for any “how is everything going?” / status question — prefer it over separately listing programs, senders, and analytics.

GET

organization

pulse

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

const { data, error } = await norbelys.organization.pulse();
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "deliverability": {
    "bounceRate": 0.02,
    "bounces": 14,
    "complaints": 1,
    "hardBounceRate": 0.01,
    "sent": 2100,
    "spamRate": 0.0005,
    "unsubscribes": 6
  },
  "object": "organization.pulse",
  "programs": [
    {
      "bounces": 3,
      "clicks": 58,
      "completion": 0.35,
      "contacted": 680,
      "dealsCreated": 4,
      "dealsLost": 1,
      "dealsWon": 2,
      "delivered": 721,
      "id": "prg_8kd0f2n1x7q4",
      "leads": 1240,
      "meetings": 3,
      "name": "Q3 Outbound — Founders",
      "openRate": 0.42,
      "opens": 312,
      "positiveReplies": 8,
      "replies": 24,
      "replyRate": 0.08,
      "sent": 740,
      "status": "active",
      "unsubscribes": 2,
      "nextSendAt": "<unknown>"
    }
  ],
  "senders": {
    "domains": 4,
    "healthy": 10,
    "paused": 1,
    "reputationBad": 0,
    "reputationWarning": 2,
    "throttled": 1,
    "total": 12
  },
  "value": {
    "dealsCreated": 12,
    "dealsLost": 3,
    "dealsWon": 5,
    "meetings": 7,
    "positiveReplies": 15,
    "replies": 48,
    "sent": 2100,
    "unsubscribes": 6
  },
  "windowDays": 7
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Org-scoped Norbelys API key. Create one in Settings → API keys and send it as Authorization: Bearer ak_….

Query Parameters

days

integer

Window in days for the engagement and deliverability metrics; defaults to 7. Example: 7

Required range: 1 <= x <= 90

Example:

7

Response

deliverability

PulseDeliverability · object

required

The account deliverability headline over the window.

Show child attributes

object

any

required

Object type discriminator — always "organization.pulse".

programs

PulseProgram · object[]

required

Every non-archived campaign with its state and window metrics — active first, then by lead count.

Show child attributes

senders

PulseSenderFleet · object

required

The mailbox fleet rolled up by state and reputation.

Show child attributes

value

PulseValue · object

required

Outcome rollup over the window (value produced, not volume).

Show child attributes

windowDays

number

required

The window (days) the metrics were computed over. Example: 7

Example:

7

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

const { data, error } = await norbelys.organization.pulse();
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "deliverability": {
    "bounceRate": 0.02,
    "bounces": 14,
    "complaints": 1,
    "hardBounceRate": 0.01,
    "sent": 2100,
    "spamRate": 0.0005,
    "unsubscribes": 6
  },
  "object": "organization.pulse",
  "programs": [
    {
      "bounces": 3,
      "clicks": 58,
      "completion": 0.35,
      "contacted": 680,
      "dealsCreated": 4,
      "dealsLost": 1,
      "dealsWon": 2,
      "delivered": 721,
      "id": "prg_8kd0f2n1x7q4",
      "leads": 1240,
      "meetings": 3,
      "name": "Q3 Outbound — Founders",
      "openRate": 0.42,
      "opens": 312,
      "positiveReplies": 8,
      "replies": 24,
      "replyRate": 0.08,
      "sent": 740,
      "status": "active",
      "unsubscribes": 2,
      "nextSendAt": "<unknown>"
    }
  ],
  "senders": {
    "domains": 4,
    "healthy": 10,
    "paused": 1,
    "reputationBad": 0,
    "reputationWarning": 2,
    "throttled": 1,
    "total": 12
  },
  "value": {
    "dealsCreated": 12,
    "dealsLost": 3,
    "dealsWon": 5,
    "meetings": 7,
    "positiveReplies": 15,
    "replies": 48,
    "sent": 2100,
    "unsubscribes": 6
  },
  "windowDays": 7
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

Analytics

Domains

Fields

Files

Groups

Integrations

Messages

Organization

People

Programs

Segments

Senders

Suppressions

Verify

Get the workspace pulse

Authorizations

Query Parameters

Response