API v3 is live and in beta: expect possible malfunctions and breaking changes in the coming days. If you find a bug, please report it to your Sillage contact.

Account monitoring

See and control which accounts are monitored.

Monitoring is how Sillage keeps watching an account for signals. It is invoiced to you per account, per persona, per month, at your partner price. There is no credit balance to top up. A persona is identified by persona_id: see Personas.

Monitoring is set with signal_buckets: ["essential"] monitors an account (mapping, signals and content), null means not monitored.

Endpoints

MethodPathDescription
GET/api/v3/partner/workspaces/{partner_workspace_id}/account-monitoringGet monitoring summary: how many accounts are monitored, what they cost.
PUT/api/v3/partner/workspaces/{partner_workspace_id}/account-monitoring/accountsMonitor or stop accounts: start or stop monitoring a selection of accounts in one persona.

Statuses

Every account has one status in a persona. A partner never sees not_covered: renewals are invoiced, so they are never refused.

StatusMeaning
monitoredThe account is monitored in this persona and its month is running.
monitored_elsewhereThe account is monitored in another persona only.
not_monitoredThe account is not monitored in this persona. If it was stopped during an invoiced month, covered_until shows when its signals end.

Read monitoring

  • Get monitoring summary: how many accounts are monitored, what they cost.
  • List members: on customer and prospect lists, each member carries monitoring, one entry per persona with its status, covered_until and not_covered_since. Filter with monitoring_status and narrow to one persona with persona_id.
  • Monitor or stop accounts: each account in changed comes back with its new status and covered_until, so you can read the result without a second call.

Change monitoring

  • Monitor or stop accounts: a selection of accounts in one persona.
  • Monitor or stop a whole list, including the accounts that join it later: send signal_buckets with PATCH /api/v3/partner/workspaces/{partner_workspace_id}/lists/{kind}/{list_id}. null stops the whole list, including the accounts picked one by one. Each list also reports signal_buckets and monitoring_by_persona: for each persona, how many accounts are monitored.

A list attached to several personas invoices each of them, and stopping an account on it stops it in each of them. Stopping never credits back the month already invoiced.

On this page