Update Monitoring Schedule

PUT

competitor-monitoring

schedule

curl -X PUT https://api.clustr-ai.com/api/public/competitor-monitoring/schedule \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "schedule": {
      "cadence": "weekly",
      "day_of_week": 1,
      "hour": 11,
      "minute": 0,
      "timezone": "Europe/Paris"
    }
  }'

import requests

requests.put(
    "https://api.clustr-ai.com/api/public/competitor-monitoring/schedule",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "enabled": True,
        "schedule": {
            "cadence": "weekly",
            "day_of_week": 1,
            "hour": 11,
            "minute": 0,
            "timezone": "Europe/Paris",
        },
    },
)

await fetch("https://api.clustr-ai.com/api/public/competitor-monitoring/schedule", {
  method: "PUT",
  headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({
    enabled: true,
    schedule: { cadence: "weekly", day_of_week: 1, hour: 11, minute: 0, timezone: "Europe/Paris" },
  }),
});

{
  "success": true,
  "data": {
    "feature_key": "competitor_monitoring",
    "enabled": true,
    "schedule": {
      "cadence": "weekly",
      "day_of_week": 1,
      "hour": 11,
      "minute": 0,
      "timezone": "Europe/Paris"
    }
  }
}

Set the day and time of the competitor collection slot, and whether it runs at all.

Every competitor is collected every two weeks. The schedule is a weekly slot, at day_of_week, hour, minute and timezone, and each competitor runs at every other one: a competitor that already ran in the last ten days, for example from a run you started, skips the slot. Your competitors can therefore alternate between two weeks. cadence is pinned to weekly (the slot) in both directions. The team refresh (new people, leavers, role changes) stays monthly, inside one of the runs.

The schedule is on by default on Mondays at 11:00 Europe/Paris and collects only once you have added competitors. What one collection reads:

The first run of a competitor, started when you add it, reads the last 90 days of its team’s activity.
Each scheduled run reads from that competitor’s previous run, minus a week of overlap.
Both directions: the comments and likes the team leaves on other people’s posts, and the comments and likes other people leave on the team’s own posts.

To collect outside the schedule, use Run Competitor Monitoring.

curl -X PUT https://api.clustr-ai.com/api/public/competitor-monitoring/schedule \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "schedule": {
      "cadence": "weekly",
      "day_of_week": 1,
      "hour": 11,
      "minute": 0,
      "timezone": "Europe/Paris"
    }
  }'

import requests

requests.put(
    "https://api.clustr-ai.com/api/public/competitor-monitoring/schedule",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "enabled": True,
        "schedule": {
            "cadence": "weekly",
            "day_of_week": 1,
            "hour": 11,
            "minute": 0,
            "timezone": "Europe/Paris",
        },
    },
)

await fetch("https://api.clustr-ai.com/api/public/competitor-monitoring/schedule", {
  method: "PUT",
  headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({
    enabled: true,
    schedule: { cadence: "weekly", day_of_week: 1, hour: 11, minute: 0, timezone: "Europe/Paris" },
  }),
});

{
  "success": true,
  "data": {
    "feature_key": "competitor_monitoring",
    "enabled": true,
    "schedule": {
      "cadence": "weekly",
      "day_of_week": 1,
      "hour": 11,
      "minute": 0,
      "timezone": "Europe/Paris"
    }
  }
}

Authorizations

Authorization

string

header

required

The API key you created on the API settings page of the Clustr app.

Body

application/json

enabled

boolean

Whether the scheduled scan runs. On by default. Set false to stop automatic scans while keeping your competitors.

schedule

object

Show child attributes

Response

The saved schedule

success

boolean

required

Example:

true

data

object

required

curl -X PUT https://api.clustr-ai.com/api/public/competitor-monitoring/schedule \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "schedule": {
      "cadence": "weekly",
      "day_of_week": 1,
      "hour": 11,
      "minute": 0,
      "timezone": "Europe/Paris"
    }
  }'

import requests

requests.put(
    "https://api.clustr-ai.com/api/public/competitor-monitoring/schedule",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "enabled": True,
        "schedule": {
            "cadence": "weekly",
            "day_of_week": 1,
            "hour": 11,
            "minute": 0,
            "timezone": "Europe/Paris",
        },
    },
)

await fetch("https://api.clustr-ai.com/api/public/competitor-monitoring/schedule", {
  method: "PUT",
  headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({
    enabled: true,
    schedule: { cadence: "weekly", day_of_week: 1, hour: 11, minute: 0, timezone: "Europe/Paris" },
  }),
});

{
  "success": true,
  "data": {
    "feature_key": "competitor_monitoring",
    "enabled": true,
    "schedule": {
      "cadence": "weekly",
      "day_of_week": 1,
      "hour": 11,
      "minute": 0,
      "timezone": "Europe/Paris"
    }
  }
}

API Reference

Import

Search

Jobs

Network

Opportunities

Owners

Accounts

Account States

Saved Views

Workflows

Intro Requests

Notes

Record Activity

Tags

Target Accounts

Client Companies

Excluded Companies

Buyer Titles

ICP

Competitor Monitoring

Connector Refresh

Notifications

Update Monitoring Schedule

Authorizations

Body

Response