Skip to content

Get Monitor Details - API Reference

Returns monitor details.

The status field is either active or paused. A monitor is paused when a charge could not be collected from your balance — it stops checking for updates and stops delivering webhooks until you top up, at which point it resumes automatically. See Pricing.

Deleted monitors are not returned by this endpoint and respond with 404 instead.

GET https://api.socialdata.tools/monitors/{monitor_id}

Headers

Authorization string required

Authorization Bearer header containing your SocialData API key

Example: Bearer YOUR_API_KEY

Path Parameters

monitor_id string required

Target monitor ID

Example: 01jeg76qa91b095gttamsbwa6q

Code Examples

Terminal window
curl "https://api.socialdata.tools/monitors/01jeg76qa91b095gttamsbwa6q" \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Accept: application/json'

Example Responses

{
"status": "success",
"data": {
"id": "01jkf3zgfwt8gnpgevxf9w6h58",
"created_at": "2025-02-07T02:31:47.000000Z",
"monitor_type": "user_following",
"status": "active",
"webhook_url": null,
"parameters": {
"user_screen_name": "elonmusk",
"user_name": "Elon Musk",
"user_id_str": "44196397"
}
}
}

Response Codes

  • 200 OK - request succeeded
  • 404 Not Found - requested monitor does not exist
  • 500 Internal Error - API internal error, typically means that SocialData API failed to obtain the requested information and you should try again later

Before you integrate