Read discovery run
curl --request GET \
--url https://api.sigmora.org/v1/discovery/runs/{runId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sigmora.org/v1/discovery/runs/{runId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sigmora.org/v1/discovery/runs/{runId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"run": {
"id": "<string>",
"contentBrandId": "<string>",
"configId": "<string>",
"kind": "discover",
"status": "queued",
"queryPlan": {
"version": "<string>",
"primaryThemeId": "<string>",
"themeIds": [
"<string>"
],
"seedTerms": [
"<string>"
],
"queries": [
{
"platform": "youtube_shorts",
"terms": [
"<string>"
],
"intents": [
"momentum"
]
}
],
"compiledAt": "2023-11-07T05:31:56Z",
"basis": [
"<string>"
],
"intent": "<string>",
"excludeKeywords": [
"<string>"
]
},
"result": {},
"error": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "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"
}Read discovery run
Read one discovery run, including per-source results and errors.
GET
/
v1
/
discovery
/
runs
/
{runId}
Read discovery run
curl --request GET \
--url https://api.sigmora.org/v1/discovery/runs/{runId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sigmora.org/v1/discovery/runs/{runId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sigmora.org/v1/discovery/runs/{runId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"run": {
"id": "<string>",
"contentBrandId": "<string>",
"configId": "<string>",
"kind": "discover",
"status": "queued",
"queryPlan": {
"version": "<string>",
"primaryThemeId": "<string>",
"themeIds": [
"<string>"
],
"seedTerms": [
"<string>"
],
"queries": [
{
"platform": "youtube_shorts",
"terms": [
"<string>"
],
"intents": [
"momentum"
]
}
],
"compiledAt": "2023-11-07T05:31:56Z",
"basis": [
"<string>"
],
"intent": "<string>",
"excludeKeywords": [
"<string>"
]
},
"result": {},
"error": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "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
A workspace API key.
Path Parameters
A discovery run id, returned by POST /v1/discovery/runs.
Required string length:
1 - 200Example:
"dsr_2c19"