Skip to content

Create subscription

Request

Create a new social-listening subscription from handles and/or discovery lists. Monitoring is billed per creator, per day — API calls are included in that price. See Usage, pricing & limits.

Security
Bearer
Bodyrequired
namestring

Optional subscription name.

platformstring

Platform to monitor. Optional when it can be derived from list_ids; required otherwise. Exactly one platform per subscription.

event_typestringrequired

Event that triggers a notification (e.g. 'new_post', 'bio_change', 'follower_threshold').

filtersobject

Event-type-specific filter object. Required for 'follower_threshold'; shape is validated against the chosen event_type.

list_idsArray of integers

Discovery list IDs whose creators are monitored. Provide handles and/or list_ids.

notify_endpointsArray of objects(NotifyEndpointInput)required

Where matching events are delivered. At least one is required.

handlesArray of strings

Creator handles to monitor. Provide handles and/or list_ids.

curl -i -X POST \
  https://api-dashboard.influencers.club/public/v1/social/listening/subscription/ \
  -H 'Authorization: Bearer <YOUR_API_KEY_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "platform": "string",
    "event_type": "string",
    "filters": {
      "property1": null,
      "property2": null
    },
    "list_ids": [
      0
    ],
    "notify_endpoints": [
      {
        "id": 0,
        "destination": "string",
        "notify_type": "api"
      }
    ],
    "handles": [
      "string"
    ]
  }'

Responses

Bodyapplication/json
idintegerrequired
namestring
subscription_typestringrequired
platformstringrequired

The creator's social media platform.

event_typestringrequired
statusstringrequired
paused_reasonstring
filtersobject or null
intervalstring

Polling interval for this subscription's event type.

notify_endpointsArray of objects(NotifyEndpoint)required

Endpoints the subscription's events are delivered to.

source_listsArray of objects(SourceList)required

Discovery lists feeding creators into the subscription.

sample_creatorsstring

Up to 3 creators (handle + avatar) attached to the subscription.

creator_countstring

Total number of creators attached to the subscription.

delivery_healthstring

Delivery counters (total, successful, and failed deliveries).

last_event_atstring

Timestamp of the most recent event for this subscription.

credits_spentstring, (decimal)required

Lifetime listening credits attributed to this subscription, accrued daily as 0.3 × its active creators (gross per-subscription). May exceed the deduplicated amount actually charged to the billing scope when creators are shared across subscriptions.

created_atstring, (date-time)required
updated_atstring, (date-time)required
Response
{ "id": 0, "name": "string", "subscription_type": "string", "platform": "string", "event_type": "string", "status": "string", "paused_reason": "string", "filters": { "property1": null, "property2": null }, "interval": "string", "notify_endpoints": [ { … } ], "source_lists": [ { … } ], "sample_creators": "string", "creator_count": "string", "delivery_health": "string", "last_event_at": "string", "credits_spent": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }