Get audience summary

GET

people

audience-summary

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

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

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

{
  "averageScore": 67.5,
  "engaged30d": 128,
  "status": [
    {
      "status": "active",
      "value": 1
    }
  ],
  "total": 1284,
  "weeklyCreated": [
    {
      "period": "<string>",
      "value": 1
    }
  ]
}

{
  "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

scope

required

Summarize the whole workspace — every person, no filter.

groupId

string

The static group whose live members to summarize.

Example:

"grp_tz4a98xat96iws9zmbrgj3a"

segmentId

string

The segment whose live matches to summarize, evaluated live.

Example:

"seg_tz4a98xat96iws9zmbrgj3a"

Response

averageScore

number | null

required

Average non-null engagement score, or null when none are scored.

Required range: 0 <= x <= 100

Example:

67.5

engaged30d

integer

required

People whose last recorded activity was in the last 30 days.

Required range: x >= 0

Example:

128

status

AudienceStatusBreakdown · object[]

required

Exact lifecycle-status distribution for the current audience.

Show child attributes

total

integer

required

Current people in the selected audience or whole workspace.

Required range: x >= 0

Example:

1284

weeklyCreated

AudienceWeekPoint · object[]

required

Current audience members grouped by the week they first entered the workspace, limited to the last 12 weeks.

Show child attributes

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

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

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

{
  "averageScore": 67.5,
  "engaged30d": 128,
  "status": [
    {
      "status": "active",
      "value": 1
    }
  ],
  "total": 1284,
  "weeklyCreated": [
    {
      "period": "<string>",
      "value": 1
    }
  ]
}

{
  "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 audience summary

Authorizations

Query Parameters

Response