Measure watched account

curl --request POST \
  --url https://api.sigmora.org/v1/competitors/{competitorId}/measure \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '{}'

import requests

url = "https://api.sigmora.org/v1/competitors/{competitorId}/measure"

payload = {}
headers = {
    "idempotency-key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'idempotency-key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
};

fetch('https://api.sigmora.org/v1/competitors/{competitorId}/measure', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "competitor": {
    "id": "<string>",
    "channelIds": [
      "<string>"
    ],
    "handle": "<string>",
    "platform": "<string>",
    "performance": {
      "status": "measured",
      "metric": "views",
      "median": 123,
      "sampleSize": 123,
      "postsRead": 123,
      "refreshedAt": "<string>",
      "reason": "<string>",
      "hits": [
        {
          "externalUploadId": "<string>",
          "url": "<string>",
          "title": "<string>",
          "outlierRatio": 123
        }
      ]
    }
  },
  "measured": true
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

Measure watched account

Measure a watched account’s usual reach and proven hits now. Reads up to 50 recent posts, takes the median of the mature ones and keeps up to 12 that beat it. Charged like the dashboard’s Measure now: one watcher scrape at the provider’s measured cost when a paid source counted the account (YouTube is free). A measurement under an hour old is returned as is (measured: false) and not charged again. A refusal (out of credits, no data key) is stored and read back under competitor.performance.reason. Send an empty JSON object.

POST

competitors

{competitorId}

measure

Measure watched account

curl --request POST \
  --url https://api.sigmora.org/v1/competitors/{competitorId}/measure \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '{}'

import requests

url = "https://api.sigmora.org/v1/competitors/{competitorId}/measure"

payload = {}
headers = {
    "idempotency-key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'idempotency-key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
};

fetch('https://api.sigmora.org/v1/competitors/{competitorId}/measure', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "competitor": {
    "id": "<string>",
    "channelIds": [
      "<string>"
    ],
    "handle": "<string>",
    "platform": "<string>",
    "performance": {
      "status": "measured",
      "metric": "views",
      "median": 123,
      "sampleSize": 123,
      "postsRead": 123,
      "refreshedAt": "<string>",
      "reason": "<string>",
      "hits": [
        {
          "externalUploadId": "<string>",
          "url": "<string>",
          "title": "<string>",
          "outlierRatio": 123
        }
      ]
    }
  },
  "measured": true
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

A workspace API key.

Headers

idempotency-key

string

required

Required stable id for this request; reuse it after a timeout to receive the same answer.

Required string length: 1 - 255

Path Parameters

competitorId

string

required

id from GET /v1/competitors.

Required string length: 1 - 200

Body

application/json

The body is of type object.

Response

Success.

success

boolean

required

competitor

object

required

Show child attributes

measured

boolean

required

False when a measurement under an hour old was returned without measuring again.

{key}

any

Meta

Projects

Sessions

Assets

Jobs

Text

Video

UGC

Editing

3D

Image

Audio

Publishing

Webhooks

Workflows

Agents

Research

Themes

Signals

Discovery

Watchlist

Performance

Autopilot

Campaigns

Brands

Products

Measure watched account

Authorizations

Headers

Path Parameters

Body

Response