Preview a monitor

Authentication

Send Authorization: Bearer gtk_…. Create the key under Connect assistant → API keys. A missing, invalid or revoked key is 401. A valid key while this API is not enabled for your organization answers 403 api_not_enabled, with what the key can do instead. Every response includes mySDR-Api-Version, mySDR-Request-Id and Cache-Control: no-store, and a response to an accepted key also X-RateLimit-* (so not a 401, a 405, an OPTIONS or a 404 for an unknown path).

Body parameters

• name string · required — 1 to 120 characters.
• keywords array · required — 1 to 10 keywords.
• max_credits_per_day integer | null — Caps the preview’s max_credits.

Response

• object string · required — Always cost_preview. One of: cost_preview.
• endpoint string · required — Which call this previews. One of: searches, leads, person.enrich, monitors.
• row_key string · required — The row type that sets the headline price.
• credits_per_row integer · required — Credits for one row of row_key.
• max_rows integer · required — The most rows this call can return.
• max_credits integer · required — The most the call can spend. A max_credits you sent caps it.
• period string · required — call for one request, day for a monitor. One of: call, day.
• rows object[] · required — Every row type the call can deliver: row_key, credits_per_row, max_rows.
• notes string[] · required — Plain-language limits of this preview.

Credits

Free. period is day. A delivered mention costs 1 credit.

Errors

• 400 invalid_request — The body would also be rejected by POST /monitors.
• 401 authentication_error — The Authorization header is missing, or the key is unknown or revoked.
• 403 permission_error — API access is not part of your plan, or your account is suspended.
• 403 api_not_enabled — The key is valid, but the Signals API or the Company API is not enabled for your organization yet. The error says what this key can do.
• 429 rate_limit_error — More than 60 requests per minute, or more than 3 at the same time, on one key. Wait for the Retry-After header.
• 500 internal_error — Something went wrong on our side.

Example

cURL

curl -X POST "https://mysdr.app/api/v1/monitors/preview" \
  -H "Authorization: Bearer $MYSDR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme mentions",
    "keywords": [
      "Acme Analytics"
    ],
    "max_credits_per_day": 50
  }'

JavaScript

const response = await fetch('https://mysdr.app/api/v1/monitors/preview', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.MYSDR_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "name": "Acme mentions",
    "keywords": [
      "Acme Analytics"
    ],
    "max_credits_per_day": 50
  })
});
const body = await response.json();

Python

import json
import os
import urllib.request

payload = {
  "name": "Acme mentions",
  "keywords": [
    "Acme Analytics"
  ],
  "max_credits_per_day": 50
}

request = urllib.request.Request(
    "https://mysdr.app/api/v1/monitors/preview",
    headers={
    "Authorization": f"Bearer {os.environ['MYSDR_API_KEY']}",
    "Content-Type": "application/json"
    },
    data=json.dumps(payload).encode(),
    method="POST",
)
with urllib.request.urlopen(request) as response:
    body = json.load(response)

Example response

{
  "object": "cost_preview",
  "endpoint": "monitors",
  "row_key": "mention",
  "credits_per_row": 1,
  "max_rows": 50,
  "max_credits": 50,
  "period": "day",
  "rows": [
    {
      "row_key": "mention",
      "credits_per_row": 1,
      "max_rows": 50
    }
  ],
  "notes": []
}