Audit a program before launch

GET

programs

{id}

audit

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

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

const { data, error } = await norbelys.programs.audit("prg_y3rgwmhkbgxx");
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "coverage": [
    {
      "code": "<string>",
      "percent": 50,
      "present": 1,
      "total": 1
    }
  ],
  "issues": [
    {
      "code": "no_steps",
      "message": "<string>",
      "severity": "error",
      "field": "program",
      "step": 2,
      "variantId": "<string>"
    }
  ],
  "previews": [
    {
      "email": "<string>",
      "label": "<string>",
      "personId": "<string>",
      "preheader": "<string>",
      "step": 2,
      "subject": "<string>",
      "textPreview": "<string>",
      "variantId": "<string>"
    }
  ],
  "programId": "<string>",
  "programName": "<string>",
  "ready": true,
  "renderAttempts": 1,
  "renderErrors": 1,
  "sampledPeople": 1,
  "status": "draft",
  "summary": {
    "aiVariants": 1,
    "leadCount": 1,
    "personalizedBodies": 1,
    "personalizedPreheaders": 1,
    "personalizedSubjects": 1,
    "senderCount": 1,
    "stepCount": 1,
    "trackClicks": true,
    "trackOpens": true,
    "unsubscribe": true,
    "variantCount": 1,
    "variantsByStep": [
      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_….

Path Parameters

string

required

The program id to audit.

Query Parameters

personId

string

Render every saved arm against this person instead of sampling enrolled leads.

sampleSize

integer

Number of enrolled people to test-render, 1-10. Defaults to 3; ignored when personId is given.

Required range: 1 <= x <= 10

Example:

3

Response

coverage

ProgramAuditFieldCoverage · object[]

required

Real fill rates for recipient merge tags over the sample.

Show child attributes

issues

ProgramAuditIssue · object[]

required

Blocking errors followed by advisory warnings and information.

Show child attributes

previews

ProgramAuditPreview · object[]

required

One successful exact render per arm, using real people and the send-time renderer.

Show child attributes

programId

string

required

The audited program id.

programName

string

required

The campaign display name.

ready

boolean

required

True when the audit found no blocking errors.

renderAttempts

integer

required

Person × arm render attempts performed.

Required range: x >= 0

renderErrors

integer

required

Render attempts that failed.

Required range: x >= 0

sampledPeople

integer

required

Real people used for rendering and field coverage.

Required range: x >= 0

status

enum<string>

required

Current campaign lifecycle status.

Available options:

draft,

active,

paused,

done

summary

ProgramAuditSummary · object

required

Compact campaign completeness and personalization rollup.

Show child attributes

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

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

const { data, error } = await norbelys.programs.audit("prg_y3rgwmhkbgxx");
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "coverage": [
    {
      "code": "<string>",
      "percent": 50,
      "present": 1,
      "total": 1
    }
  ],
  "issues": [
    {
      "code": "no_steps",
      "message": "<string>",
      "severity": "error",
      "field": "program",
      "step": 2,
      "variantId": "<string>"
    }
  ],
  "previews": [
    {
      "email": "<string>",
      "label": "<string>",
      "personId": "<string>",
      "preheader": "<string>",
      "step": 2,
      "subject": "<string>",
      "textPreview": "<string>",
      "variantId": "<string>"
    }
  ],
  "programId": "<string>",
  "programName": "<string>",
  "ready": true,
  "renderAttempts": 1,
  "renderErrors": 1,
  "sampledPeople": 1,
  "status": "draft",
  "summary": {
    "aiVariants": 1,
    "leadCount": 1,
    "personalizedBodies": 1,
    "personalizedPreheaders": 1,
    "personalizedSubjects": 1,
    "senderCount": 1,
    "stepCount": 1,
    "trackClicks": true,
    "trackOpens": true,
    "unsubscribe": true,
    "variantCount": 1,
    "variantsByStep": [
      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

Audit a program before launch

Authorizations

Path Parameters

Query Parameters

Response