Integration API

Metrics

Card APIs for Overview, Presence, Life, Gravity, Scout, and Market. All paths are relative to https://api.symios.ai/v2/integration and require X-Api-Key and X-Api-Secret. Successful responses return the JSON payload directly (no wrapper).

Overview

Summary

Endpoint

GET /home/sets/{querySetId}/summary

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "content": "Brand visibility is stable this period; ChatGPT remains the strongest engine."
}

Example

curl -sS "https://api.symios.ai/v2/integration/home/sets/42/summary?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/home/sets/42/summary?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/home/sets/42/summary?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Competitive Context

Endpoint

GET /home/sets/{querySetId}/competitive-context

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "dStar": 4.25,
    "fairShare": 12.5,
    "shares": [
        {
            "name": "Acme",
            "share": 18.4,
            "isBrand": true,
            "isTargeted": false
        },
        {
            "name": "RivalCo",
            "share": 14.2,
            "isBrand": false,
            "isTargeted": true
        },
        {
            "name": "Other (across 42 competitors)",
            "share": 31.1,
            "isBrand": false,
            "isTargeted": false
        }
    ]
}

Example

curl -sS "https://api.symios.ai/v2/integration/home/sets/42/competitive-context?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/home/sets/42/competitive-context?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/home/sets/42/competitive-context?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Presence

Gross

Endpoint

GET /presence/sets/{querySetId}/gross

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "current": 42.75,
    "delta": 1.3,
    "history": [
        38.2,
        40.1,
        41.45,
        42.75
    ],
    "historyLabels": [
        "W01",
        "W02",
        "W03",
        "W04"
    ]
}

Example

curl -sS "https://api.symios.ai/v2/integration/presence/sets/42/gross?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/presence/sets/42/gross?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/presence/sets/42/gross?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Weighted

Endpoint

GET /presence/sets/{querySetId}/weighted

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "current": 16.8,
    "delta": -0.45,
    "fairShare": 12.5,
    "dStar": 4.25,
    "classification": "Competitive",
    "history": [
        15.2,
        16.1,
        17.25,
        16.8
    ],
    "historyLabels": [
        "W01",
        "W02",
        "W03",
        "W04"
    ]
}

Example

curl -sS "https://api.symios.ai/v2/integration/presence/sets/42/weighted?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/presence/sets/42/weighted?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/presence/sets/42/weighted?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Position Distribution

Endpoint

GET /presence/sets/{querySetId}/position-distribution

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "p1": 0.3125,
    "p2": 0.215,
    "p3": 0.18,
    "p4plus": 0.2925,
    "totalAnswers": 240,
    "totalAll": 980,
    "prev": {
        "p1": 0.29,
        "p2": 0.22,
        "p3": 0.19,
        "p4plus": 0.3
    }
}

Example

curl -sS "https://api.symios.ai/v2/integration/presence/sets/42/position-distribution?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/presence/sets/42/position-distribution?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/presence/sets/42/position-distribution?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Position Distribution by Engine

Endpoint

GET /presence/sets/{querySetId}/position-distribution-by-engine

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "engines": [
        {
            "id": 1,
            "label": "ChatGPT",
            "color": "#0F95E2",
            "timesCited": 86,
            "p1": 34,
            "p2": 22,
            "p3": 18,
            "p4plus": 26,
            "deltaTimesCited": 4
        }
    ],
    "totals": {
        "timesCited": 240,
        "p1": 31,
        "p2": 22,
        "p3": 18,
        "p4plus": 29,
        "deltaTimesCited": 12
    }
}

Example

curl -sS "https://api.symios.ai/v2/integration/presence/sets/42/position-distribution-by-engine?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/presence/sets/42/position-distribution-by-engine?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/presence/sets/42/position-distribution-by-engine?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

By Engine

Endpoint

GET /presence/sets/{querySetId}/by-engine

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "engines": [
        {
            "id": 1,
            "label": "ChatGPT",
            "image": "https://cdn.example/llm/chatgpt.png",
            "color": "#0F95E2"
        }
    ],
    "presenceByEngine": {
        "1": {
            "weighted": 18.4,
            "gross": 44.2,
            "delta": 0.8
        }
    }
}

Example

curl -sS "https://api.symios.ai/v2/integration/presence/sets/42/by-engine?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/presence/sets/42/by-engine?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/presence/sets/42/by-engine?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

By Intent

Endpoint

GET /presence/sets/{querySetId}/by-intent

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "intents": [
        {
            "id": 12,
            "label": "Compare brands",
            "stage": "Consideration",
            "icv": 2
        }
    ],
    "presenceByIntent": {
        "12": {
            "weighted": 21.5,
            "gross": 48,
            "deltaW": 1.2,
            "deltaG": -0.5
        }
    }
}

Example

curl -sS "https://api.symios.ai/v2/integration/presence/sets/42/by-intent?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/presence/sets/42/by-intent?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/presence/sets/42/by-intent?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Engine Intent Matrix

Endpoint

GET /presence/sets/{querySetId}/engine-intent-matrix

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "engines": [
        {
            "id": 1,
            "label": "ChatGPT",
            "color": "#0F95E2",
            "image": "https://cdn.example/llm/chatgpt.png"
        }
    ],
    "intents": [
        {
            "id": 12,
            "label": "Compare brands"
        }
    ],
    "engineIntentMatrix": {
        "1": {
            "12": 19.75
        }
    }
}

Example

curl -sS "https://api.symios.ai/v2/integration/presence/sets/42/engine-intent-matrix?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/presence/sets/42/engine-intent-matrix?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/presence/sets/42/engine-intent-matrix?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Life

KPI

Endpoint

GET /life/sets/{querySetId}/kpi

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "current": 62.4,
    "delta": 1.8,
    "history": [
        58.1,
        59.9,
        60.6,
        62.4
    ],
    "historyLabels": [
        "W01",
        "W02",
        "W03",
        "W04"
    ]
}

Example

curl -sS "https://api.symios.ai/v2/integration/life/sets/42/kpi?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/life/sets/42/kpi?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/life/sets/42/kpi?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Recommended Share

Endpoint

GET /life/sets/{querySetId}/recommended-share

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "current": 0.284,
    "delta": 2.1,
    "history": [
        24.5,
        25.8,
        26.3,
        28.4
    ],
    "historyLabels": [
        "W01",
        "W02",
        "W03",
        "W04"
    ]
}

Example

curl -sS "https://api.symios.ai/v2/integration/life/sets/42/recommended-share?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/life/sets/42/recommended-share?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/life/sets/42/recommended-share?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Neutral Share

Endpoint

GET /life/sets/{querySetId}/neutral-share

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "current": 0.412,
    "delta": -0.8,
    "history": [
        43,
        42.1,
        42,
        41.2
    ],
    "historyLabels": [
        "W01",
        "W02",
        "W03",
        "W04"
    ]
}

Example

curl -sS "https://api.symios.ai/v2/integration/life/sets/42/neutral-share?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/life/sets/42/neutral-share?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/life/sets/42/neutral-share?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Negative Share

Endpoint

GET /life/sets/{querySetId}/negative-share

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "current": 0.118,
    "delta": 0.4,
    "history": [
        10.2,
        11,
        11.4,
        11.8
    ],
    "historyLabels": [
        "W01",
        "W02",
        "W03",
        "W04"
    ]
}

Example

curl -sS "https://api.symios.ai/v2/integration/life/sets/42/negative-share?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/life/sets/42/negative-share?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/life/sets/42/negative-share?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Positive Negative Ratio

Endpoint

GET /life/sets/{querySetId}/positive-negative-ratio

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "current": 2.41,
    "delta": 0.15,
    "history": [
        2.1,
        2.2,
        2.26,
        2.41
    ],
    "historyLabels": [
        "W01",
        "W02",
        "W03",
        "W04"
    ]
}

Example

curl -sS "https://api.symios.ai/v2/integration/life/sets/42/positive-negative-ratio?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/life/sets/42/positive-negative-ratio?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/life/sets/42/positive-negative-ratio?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Stance Mix

Endpoint

GET /life/sets/{querySetId}/stance-mix

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "recommended": 0.12,
    "advisedNotFavored": 0.164,
    "neutral": 0.412,
    "cautious": 0.186,
    "negative": 0.118,
    "engineCount": 4,
    "prev": {
        "recommended": 0.11,
        "advisedNotFavored": 0.15,
        "neutral": 0.43,
        "cautious": 0.19,
        "negative": 0.12
    }
}

Example

curl -sS "https://api.symios.ai/v2/integration/life/sets/42/stance-mix?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/life/sets/42/stance-mix?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/life/sets/42/stance-mix?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Stance History

Endpoint

GET /life/sets/{querySetId}/stance-history

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "measurements": [
        "W01",
        "W02",
        "W03",
        "W04"
    ],
    "series": {
        "recommended": [
            10.5,
            11,
            11.5,
            12
        ],
        "advisedNotFavored": [
            15,
            15.5,
            16,
            16.4
        ],
        "neutral": [
            43,
            42.5,
            42,
            41.2
        ],
        "cautious": [
            19,
            18.8,
            18.5,
            18.6
        ],
        "negative": [
            12.5,
            12.2,
            12,
            11.8
        ]
    }
}

Example

curl -sS "https://api.symios.ai/v2/integration/life/sets/42/stance-history?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/life/sets/42/stance-history?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/life/sets/42/stance-history?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Scatter

Endpoint

GET /life/sets/{querySetId}/scatter

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "intents": [
        {
            "id": 12,
            "label": "Compare brands",
            "stage": "Consideration",
            "icv": 2
        }
    ],
    "presenceByIntent": {
        "12": {
            "weighted": 21.5
        }
    },
    "lifeByIntent": {
        "12": {
            "life": 64.2
        }
    },
    "weightedPresenceCurrent": 16.8,
    "lifeCurrent": 62.4
}

Example

curl -sS "https://api.symios.ai/v2/integration/life/sets/42/scatter?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/life/sets/42/scatter?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/life/sets/42/scatter?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

By Engine

Endpoint

GET /life/sets/{querySetId}/by-engine

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "engines": [
        {
            "id": 1,
            "label": "ChatGPT",
            "image": "https://cdn.example/llm/chatgpt.png",
            "color": "#0F95E2"
        }
    ],
    "lifeByEngine": {
        "1": {
            "life": 68.5,
            "delta": 1.2,
            "stance": {
                "rec": 0.14,
                "adv": 0.18,
                "neu": 0.4,
                "cau": 0.16,
                "neg": 0.12
            }
        }
    }
}

Example

curl -sS "https://api.symios.ai/v2/integration/life/sets/42/by-engine?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/life/sets/42/by-engine?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/life/sets/42/by-engine?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

By Intent

Endpoint

GET /life/sets/{querySetId}/by-intent

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "intents": [
        {
            "id": 12,
            "label": "Compare brands",
            "stage": "Consideration",
            "icv": 2
        }
    ],
    "lifeByIntent": {
        "12": {
            "life": 64.2,
            "delta": 0.9,
            "presence": 21.5,
            "stance": {
                "rec": 0.13,
                "adv": 0.17,
                "neu": 0.41,
                "cau": 0.17,
                "neg": 0.12
            }
        }
    }
}

Example

curl -sS "https://api.symios.ai/v2/integration/life/sets/42/by-intent?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/life/sets/42/by-intent?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/life/sets/42/by-intent?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Gravity

Gravity Plus

Endpoint

GET /gravity/sets/{querySetId}/gravity-plus

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "current": 78.5,
    "delta": 1.2,
    "history": [
        74,
        76.1,
        77.3,
        78.5
    ],
    "historyLabels": [
        "W01",
        "W02",
        "W03",
        "W04"
    ]
}

Example

curl -sS "https://api.symios.ai/v2/integration/gravity/sets/42/gravity-plus?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/gravity/sets/42/gravity-plus?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/gravity/sets/42/gravity-plus?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Gravity Minus

Endpoint

GET /gravity/sets/{querySetId}/gravity-minus

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "current": 12.4,
    "delta": -0.6,
    "history": [
        14,
        13.5,
        13,
        12.4
    ],
    "historyLabels": [
        "W01",
        "W02",
        "W03",
        "W04"
    ]
}

Example

curl -sS "https://api.symios.ai/v2/integration/gravity/sets/42/gravity-minus?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/gravity/sets/42/gravity-minus?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/gravity/sets/42/gravity-minus?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Open Errors

Endpoint

GET /gravity/sets/{querySetId}/open-errors

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "count": 7,
    "delta": -2,
    "resolvedSinceBaseline": 2,
    "history": [
        11,
        10,
        9,
        7
    ],
    "historyLabels": [
        "W01",
        "W02",
        "W03",
        "W04"
    ]
}

Example

curl -sS "https://api.symios.ai/v2/integration/gravity/sets/42/open-errors?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/gravity/sets/42/open-errors?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/gravity/sets/42/open-errors?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Source Distribution

Endpoint

GET /gravity/sets/{querySetId}/source-distribution

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "owned": 0.42,
    "partner": 0.23,
    "external": 0.35
}

Example

curl -sS "https://api.symios.ai/v2/integration/gravity/sets/42/source-distribution?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/gravity/sets/42/source-distribution?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/gravity/sets/42/source-distribution?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

By Engine

Endpoint

GET /gravity/sets/{querySetId}/by-engine

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "engines": [
        {
            "id": 1,
            "label": "ChatGPT",
            "image": "https://cdn.example/llm/chatgpt.png",
            "color": "#0F95E2"
        }
    ],
    "gravityByEngine": {
        "1": {
            "gPlus": 81,
            "gMinus": 9.5,
            "gravityPlus": 81.25,
            "gravityMinus": 9.5
        }
    }
}

Example

curl -sS "https://api.symios.ai/v2/integration/gravity/sets/42/by-engine?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/gravity/sets/42/by-engine?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/gravity/sets/42/by-engine?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Error Register

Endpoint

GET /gravity/sets/{querySetId}/error-register

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "engines": [
        {
            "id": 1,
            "label": "ChatGPT",
            "image": "https://cdn.example/llm/chatgpt.png",
            "color": "#0F95E2"
        }
    ],
    "gravityErrors": [
        {
            "id": "FACT-042",
            "title": "What year was Acme founded?",
            "correct": "2014",
            "note": null,
            "wrong": [
                {
                    "engine": 1,
                    "text": "Answer claimed 2012; contradicts ground truth."
                }
            ]
        }
    ]
}

Example

curl -sS "https://api.symios.ai/v2/integration/gravity/sets/42/error-register?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/gravity/sets/42/error-register?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/gravity/sets/42/error-register?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Trend

Endpoint

GET /gravity/sets/{querySetId}/trend

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "historyPlus": [
        74,
        76.1,
        77.3,
        78.5
    ],
    "historyMinus": [
        14,
        13.5,
        13,
        12.4
    ],
    "measurements": [
        {
            "id": 101,
            "label": "W01"
        },
        {
            "id": 102,
            "label": "W02"
        },
        {
            "id": 103,
            "label": "W03"
        },
        {
            "id": 104,
            "label": "W04"
        }
    ]
}

Example

curl -sS "https://api.symios.ai/v2/integration/gravity/sets/42/trend?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/gravity/sets/42/trend?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/gravity/sets/42/trend?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Source Distribution History

Endpoint

GET /gravity/sets/{querySetId}/source-distribution-history

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "measurements": [
        "W01",
        "W02",
        "W03",
        "W04"
    ],
    "series": {
        "owned": [
            38,
            40,
            41,
            42
        ],
        "partner": [
            25,
            24,
            23.5,
            23
        ],
        "external": [
            37,
            36,
            35.5,
            35
        ]
    }
}

Example

curl -sS "https://api.symios.ai/v2/integration/gravity/sets/42/source-distribution-history?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/gravity/sets/42/source-distribution-history?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/gravity/sets/42/source-distribution-history?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Scout

Landscape Stats

Endpoint

GET /scout/sets/{querySetId}/landscape-stats

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "totalDomains": 186,
    "totalUrls": 1240,
    "multiEngineDomains": 54,
    "historyLabels": [
        "W01",
        "W02",
        "W03",
        "W04"
    ],
    "domainsHistory": [
        160,
        172,
        180,
        186
    ],
    "urlsHistory": [
        980,
        1050,
        1180,
        1240
    ],
    "multiEngineHistory": [
        40,
        46,
        50,
        54
    ],
    "domainsDelta": 6,
    "urlsDelta": 60
}

Example

curl -sS "https://api.symios.ai/v2/integration/scout/sets/42/landscape-stats?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/scout/sets/42/landscape-stats?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/scout/sets/42/landscape-stats?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Source Landscape

Endpoint

GET /scout/sets/{querySetId}/source-landscape

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.
`sort`	string	No	Sort field: name, citations, engines, or delta.
`dir`	string	No	Sort direction: asc or desc. Defaults to desc.
`limit`	integer	No	Maximum number of sources to return.

Return

{
    "sourcesDetail": [
        {
            "name": "www.acme.com",
            "citations": 48,
            "engines": 3,
            "control": "owned",
            "sourceType": "corporate",
            "delta": 5
        }
    ],
    "totalCount": 186,
    "engineCount": 4
}

Example

curl -sS "https://api.symios.ai/v2/integration/scout/sets/42/source-landscape?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/scout/sets/42/source-landscape?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/scout/sets/42/source-landscape?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

References by LLM

Endpoint

GET /scout/sets/{querySetId}/references-by-llm

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "engines": [
        {
            "id": 1,
            "label": "ChatGPT",
            "color": "#0F95E2"
        }
    ],
    "dataByEngine": {
        "1": {
            "weighted": 420
        }
    }
}

Example

curl -sS "https://api.symios.ai/v2/integration/scout/sets/42/references-by-llm?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/scout/sets/42/references-by-llm?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/scout/sets/42/references-by-llm?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

References by Intent

Endpoint

GET /scout/sets/{querySetId}/references-by-intent

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "intents": [
        {
            "id": 12,
            "label": "Compare brands",
            "stage": "Consideration"
        }
    ],
    "presenceByIntent": {
        "12": {
            "weighted": 18.5
        }
    }
}

Example

curl -sS "https://api.symios.ai/v2/integration/scout/sets/42/references-by-intent?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/scout/sets/42/references-by-intent?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/scout/sets/42/references-by-intent?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Citation Occurrences

Endpoint

GET /scout/sets/{querySetId}/citation-occurrences

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "engines": [
        "ChatGPT",
        "Gemini",
        "Perplexity"
    ],
    "categories": [
        {
            "key": "brand",
            "label": "Acme",
            "color": "#1B0952"
        },
        {
            "key": "comp_88",
            "label": "RivalCo",
            "color": "#AE36C9"
        }
    ],
    "series": {
        "brand": [
            42,
            38,
            29
        ],
        "comp_88": [
            31,
            27,
            22
        ]
    }
}

Example

curl -sS "https://api.symios.ai/v2/integration/scout/sets/42/citation-occurrences?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/scout/sets/42/citation-occurrences?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/scout/sets/42/citation-occurrences?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Market

Data

Endpoint

GET /market/sets/{querySetId}/data

Query string parameters

Name	Type	Required	Description
`start_run_id`	integer	No	Lower bound published run for history series.
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "measurements": [
        {
            "id": 101,
            "label": "W01"
        },
        {
            "id": 104,
            "label": "W04"
        }
    ],
    "market": {
        "dStar": {
            "current": 4.25,
            "delta": 0.1,
            "history": [
                4,
                4.1,
                4.15,
                4.25
            ]
        },
        "tBar": {
            "current": 2.35,
            "delta": 0.05,
            "history": [
                2.2,
                2.25,
                2.3,
                2.35
            ]
        },
        "totalResponses": {
            "current": 1200,
            "delta": 40,
            "history": [
                1100,
                1140,
                1160,
                1200
            ]
        },
        "responsesWithBrands": {
            "current": 860,
            "delta": 20,
            "history": [
                800,
                820,
                840,
                860
            ]
        },
        "responsesWithoutBrands": {
            "current": 340,
            "delta": 20,
            "history": [
                300,
                320,
                320,
                340
            ]
        },
        "uniqueBrands": {
            "current": 48,
            "delta": 2,
            "history": [
                44,
                45,
                46,
                48
            ]
        }
    },
    "weightedPresence": {
        "fairShare": 12.5,
        "fairShareMetric": {
            "current": 12.5,
            "delta": 0,
            "history": [
                12.5,
                12.5,
                12.5,
                12.5
            ]
        }
    }
}

Example

curl -sS "https://api.symios.ai/v2/integration/market/sets/42/data?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/market/sets/42/data?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/market/sets/42/data?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Life Monitored Competitors

Endpoint

GET /market/sets/{querySetId}/life-monitored-competitors

Query string parameters

Name	Type	Required	Description
`end_run_id`	integer	No	Published run to use. Defaults to the latest published run.

Return

{
    "shares": [
        {
            "name": "Acme",
            "share": 62.4,
            "isBrand": true,
            "isTargeted": false
        },
        {
            "name": "RivalCo",
            "share": 48.1,
            "isBrand": false,
            "isTargeted": true
        }
    ]
}

Example

curl -sS "https://api.symios.ai/v2/integration/market/sets/42/life-monitored-competitors?end_run_id=104" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

const response = await fetch('https://api.symios.ai/v2/integration/market/sets/42/life-monitored-competitors?end_run_id=104', {
  headers: {
    'X-Api-Key': 'sk_live_YOUR_KEY',
    'X-Api-Secret': 'YOUR_SECRET',
  },
});
const data = await response.json();
console.log(data);

$ch = curl_init('https://api.symios.ai/v2/integration/market/sets/42/life-monitored-competitors?end_run_id=104');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-Api-Key: sk_live_YOUR_KEY',
    'X-Api-Secret: YOUR_SECRET',
  ],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);