Nyne.ai API Login
Person APIs

People Competitor Engagement API

Tracks the social engagements (comments, reactions, interactions) of one or more supported professional profiles to surface warm-lead signals. Accepts up to 50 profile URLs and returns the engagement results. The request is queued and returns a request_id to poll, or a callback_url receives the completed result.

POST https://api.nyne.ai/person/competitor-engagements API key

Manual credentials take precedence over your account key.

Try it needs this required parameter:

Overview

The People Competitor Engagement API identifies people who engage with competitor content, helping sales and growth teams prioritize accounts with demonstrated market interest.

Best for

  • Finding warm competitive signals
  • Prioritizing prospects by engagement
  • Building competitive-intelligence workflows

Returns

  • Matched people
  • Competitor post context
  • Engagement metadata

Parameters

linkedin_urls array required
Array of supported professional profile URLs (/in/… or sales-nav profile URLs). Max 50. linkedin_url is accepted as a single-value alias.
0 / 50
max_items integer optional
Max engagement results to return. Default 20, capped at 100.
callback_url string optional
If set, the completed result is POSTed here when the job finishes. Must be a valid HTTP(S) URL on an allowed host when a callback allow-list is configured.

Retrieving the result

This endpoint is asynchronous. A successful submit returns a request_id while the job runs in the background. Poll the same path with a GET request - same authentication headers - passing the request_id as a query parameter:

Loading your API credentials...

Each poll returns the job's current status; once it is completed the payload carries the result shown under Responses. Polling an unknown or expired request_id returns 404 request_not_found.

Status Meaning
queued · processing · pending The job is still running - keep polling.
completed The job finished; the payload carries the result and completed: true.
failed Terminal - the job could not complete; the error field explains why.

Poll every few seconds at first, backing off for long-running jobs. Polling is free - status checks never burn credits.

Prefer push delivery?
Supply the optional callback_url parameter and the completed payload is POSTed to your endpoint when the job finishes - no polling required. Delivery is retried up to 5 times with exponential backoff (1s, 5s, 15s, 1m, 5m) and a 30-second timeout per attempt; respond with a 2xx status to acknowledge receipt.

Credit usage

Credits are charged based on the matched configuration. The listed cost is the per-result unit price.

Feature Credits Notes
Per Engagement Result 5 5 credits per interaction returned
No results 0 No engagements returned never burns credits
Heads up
Empty results do not burn credits.

Responses

200 Status poll result - returns the current request status and result/error fields when available
202 Request queued - poll the status endpoint (or wait for the callback) with the returned request_id
400 Malformed JSON, missing required parameters, or an invalid field
401 Missing or invalid API credentials
402 insufficient_credits - not enough credits to complete the request
403 subscription_required or ip_not_allowed
404 request_not_found - no matching request is available for this API key
429 rate_limit_exceeded
503 service_unavailable - the API is temporarily unavailable

A successful response wraps the payload in the { success, data, timestamp } envelope (also shown live in the panel on the right):

{
  "success": true,
  "data": {
    "request_id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4_1717000000_4271",
    "status": "completed",
    "completed": true,
    "result": [
      {
        "linkedin_profile_url": "https://linkedin.com/in/janedoe",
        "actor": {
          "name": "Jane Doe",
          "profile_url": "https://linkedin.com/in/janedoe"
        },
        "interaction_type": "comment",
        "interaction_url": "https://linkedin.com/feed/update/urn:li:activity:abc123",
        "interaction_date": "2026-01-15T08:30:00Z",
        "content": "Great insight on SaaS pricing models.",
        "engagement": {
          "likes": 5,
          "replies": 2
        }
      }
    ],
    "completed_on": "2026-01-15T10:35:00Z"
  },
  "timestamp": "2026-01-01T00:00:00"
}