Overview

The Competitor Engagements API lets you discover what content a LinkedIn profile has been engaging with. By providing a LinkedIn profile URL, you can track their recent comments, reactions, and interactions on posts - useful for identifying leads, monitoring competitor activity, and understanding who your competitors are talking to.

Authentication

All API requests require authentication using your API key and secret. You can authenticate using either HTTP headers (recommended) or query parameters.

X-API-Key: your_api_key_here
X-API-Secret: your_api_secret_here

Rate Limits

API usage is controlled by rate limiting mechanisms to ensure fair usage and system stability:

• Per Minute: 60 requests
• Per Hour: 1000 requests
• Monthly: Varies by plan

Credit Usage

Credits are charged based on the number of engagement results returned:

• Per Engagement Result: 5 credits per interaction returned
• No Results: No credits charged if no engagements are found

POST /person/competitor-engagements

Submit a request to retrieve competitor engagement data for a LinkedIn profile.

curl -X POST https://api.nyne.ai/person/competitor-engagements \
  -H "X-API-Key: your_api_key_here" \
  -H "X-API-Secret: your_api_secret_here" \
  -H "Content-Type: application/json" \
  -d '{
    "linkedin_urls": [
      "https://www.linkedin.com/in/johndoe",
      "https://www.linkedin.com/in/janesmith"
    ],
    "max_items": 20
  }'

import requests
import json

url = "https://api.nyne.ai/person/competitor-engagements"
headers = {
    "X-API-Key": "your_api_key_here",
    "X-API-Secret": "your_api_secret_here",
    "Content-Type": "application/json"
}

data = {
    "linkedin_urls": [
        "https://www.linkedin.com/in/johndoe",
        "https://www.linkedin.com/in/janesmith"
    ],
    "max_items": 20
}

response = requests.post(url, headers=headers, json=data)
result = response.json()
print(json.dumps(result, indent=2))

const url = "https://api.nyne.ai/person/competitor-engagements";
const headers = {
    "X-API-Key": "your_api_key_here",
    "X-API-Secret": "your_api_secret_here",
    "Content-Type": "application/json"
};

const data = {
    linkedin_urls: [
        "https://www.linkedin.com/in/johndoe",
        "https://www.linkedin.com/in/janesmith"
    ],
    max_items: 20
};

fetch(url, {
    method: "POST",
    headers: headers,
    body: JSON.stringify(data)
})
.then(response => response.json())
.then(result => console.log(result))
.catch(error => console.error("Error:", error));

<?php
 = "https://api.nyne.ai/person/competitor-engagements";
 = [
    "X-API-Key: your_api_key_here",
    "X-API-Secret: your_api_secret_here",
    "Content-Type: application/json"
];

 = [
    "linkedin_urls" => [
        "https://www.linkedin.com/in/johndoe",
        "https://www.linkedin.com/in/janesmith"
    ],
    "max_items" => 20
];

 = curl_init();
curl_setopt(, CURLOPT_URL, );
curl_setopt(, CURLOPT_POST, true);
curl_setopt(, CURLOPT_POSTFIELDS, json_encode());
curl_setopt(, CURLOPT_HTTPHEADER, );
curl_setopt(, CURLOPT_RETURNTRANSFER, true);

 = curl_exec();
 = json_decode(, true);
curl_close();

echo json_encode(, JSON_PRETTY_PRINT);
?>

GET /person/competitor-engagements

Check the status of a competitor engagements request and retrieve results when complete.

Response Format

All API responses follow a consistent JSON format:

Success Response

Error Response

Interaction Result Fields

Error Codes

Callback System

When you provide a callback_url, the API will send the engagement results to your endpoint via HTTP POST when processing completes.

Callback Request Format

Failure Callback Format

Callback Retry Policy

• 30-second timeout per request
• Your endpoint should return HTTP 2xx for success

Important: Your callback endpoint should respond with HTTP 200-299 to indicate successful receipt.