List mentions

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).

Query parameters

• monitor_id string — Only mentions of this monitor (mon_…). A monitor that is not yours is 404.
• min_relevance string — Drop mentions below this. One of: high, medium, low.
• limit integer — How many rows to return, from 1 to 100. Defaults to 25.
• cursor string — The next_cursor of the previous page, sent back unchanged.

Response

• object string · required — Always list.
• data object[] · required — Mentions: id (men_…), monitor_id, keywords, relevance, tag, text, url, occurred_at, author_name, author_linkedin_url, author_headline, author_type (person or company), credits_charged, sources. keywords lists the keywords the post counts for, as { "keyword": "…" }, in the order of the monitor; it is empty for mentions delivered before that field existed. author_linkedin_url is the profile, or the company page when a company posted, and null on mentions from before that field.
• has_more boolean · required — Whether another page exists.
• next_cursor string | null · required — The next page, or null.
• credits_charged integer · required — Always 0. Reading does not charge.

Credits

Free to read. Each mention was charged 1 credit when the run stored it.

Errors

• 404 not_found — No monitor with this id exists for your organization.
• 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 "https://mysdr.app/api/v1/mentions?monitor_id=mon_01J9Z6P8C8V0K3W6T2N8R5M1XF&min_relevance=high" \
  -H "Authorization: Bearer $MYSDR_API_KEY"

JavaScript

const response = await fetch('https://mysdr.app/api/v1/mentions?monitor_id=mon_01J9Z6P8C8V0K3W6T2N8R5M1XF&min_relevance=high', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.MYSDR_API_KEY}`
  }
});
const body = await response.json();

Python

import json
import os
import urllib.request

request = urllib.request.Request(
    "https://mysdr.app/api/v1/mentions?monitor_id=mon_01J9Z6P8C8V0K3W6T2N8R5M1XF&min_relevance=high",
    headers={
    "Authorization": f"Bearer {os.environ['MYSDR_API_KEY']}"
    },
    method="GET",
)
with urllib.request.urlopen(request) as response:
    body = json.load(response)

Example response

{
  "object": "list",
  "data": [
    {
      "id": "men_01J9Z6P8C8V0K3W6T2N8R5M1XG",
      "object": "mention",
      "monitor_id": "mon_01J9Z6P8C8V0K3W6T2N8R5M1XF",
      "keywords": [
        {
          "keyword": "Acme Analytics"
        }
      ],
      "relevance": "high",
      "tag": "own_brand_mention",
      "text": "We switched our reporting to Acme Analytics.",
      "credits_charged": 1,
      "sources": [
        "linkedin"
      ]
    }
  ],
  "has_more": false,
  "next_cursor": null,
  "credits_charged": 0
}