A valid request URL is required to generate request examples{
"sourceHealth": {
"identity": {
"sellerAccount": {
"id": "<string>",
"name": "<string>"
},
"source": {
"id": "<string>",
"sourceId": "<string>",
"name": "<string>",
"executionType": "<string>"
},
"agent": {
"id": "<string>",
"name": "<string>",
"observedRevision": "<string>"
},
"routing": {
"eligible": true,
"setupComplete": true,
"willReceiveRequest": true,
"reasonCodes": [
"<string>"
],
"setupSteps": [
{
"id": "currency",
"scope": "seller_account",
"action": {
"kind": "open",
"label": "<string>"
}
}
]
}
},
"health": [
{
"operation": "get_products",
"supported": true,
"status": "healthy",
"condition": "timeout",
"lastOkAt": "<string>",
"lastFailureAt": "<string>",
"lastFailure": "<string>",
"owner": "seller",
"window": {
"calls": 4503599627370495,
"succeeded": 4503599627370495,
"failed": 4503599627370495,
"timedOut": 4503599627370495
},
"findingIds": [
"<string>"
]
}
],
"writes": [
{
"taskKind": "media_buy",
"attempts": 4503599627370495,
"succeeded": 4503599627370495,
"failed": 4503599627370495,
"open": 4503599627370495,
"neverAnswered": 4503599627370495,
"oldestOpenAt": "<string>",
"topFailure": {
"errorCode": "<string>",
"recovery": "transient",
"count": 4503599627370495
},
"owner": "seller"
}
],
"diagnosis": {
"severity": "blocking",
"owner": "seller",
"findings": [
{
"id": "<string>",
"code": "<string>",
"operation": "get_products",
"owner": "seller",
"severity": "blocking",
"summary": "<string>",
"detail": "<string>",
"action": {
"kind": "recheck",
"label": "<string>",
"operation": "refresh_esa",
"pathParams": {}
},
"docsAnchor": "<string>",
"observedAt": "<string>",
"evidence": {
"operation": "get_products",
"window": {
"startedAt": "<string>",
"endedAt": "<string>"
},
"target": "widget_evidence"
},
"unresolvableCreativeFormats": [
{
"productId": "<string>",
"formats": [
{
"id": "<string>",
"agentUrl": "<string>"
}
]
}
]
}
]
},
"operations": [
{
"id": "<string>",
"operation": "get_products",
"subject": {
"kind": "<string>",
"id": "<string>",
"revision": 0
},
"state": "open",
"settlement": "response",
"startedAt": "<string>",
"settledAt": "<string>",
"owner": "seller",
"waitingOn": {
"party": "seller",
"since": "<string>",
"target": {
"kind": "approval",
"id": "<string>"
},
"nextAction": {
"tool": "open_media_buy_timeline",
"arguments": {}
}
},
"attempts": [
{
"attemptNumber": 4503599627370495,
"startedAt": "<string>",
"completedAt": "<string>",
"outcome": "started",
"condition": "timeout",
"httpStatus": 0,
"latencyMs": 4503599627370495,
"errorCode": "<string>",
"recovery": "transient",
"handoff": {
"taskId": "<string>",
"debugId": "<string>",
"idempotencyKey": "<string>",
"traceId": "<string>"
},
"bodies": {
"state": "visible",
"request": "<string>",
"response": "<string>"
}
}
]
}
],
"operationsTruncated": true,
"liveEvidence": {
"useCases": [
{
"useCaseId": "<string>",
"status": "failing",
"lastPassedAt": "<string>",
"failingCheck": {
"check": "<string>",
"owner": "seller",
"action": {
"kind": "recheck",
"label": "<string>",
"operation": "refresh_esa",
"pathParams": {}
}
}
}
],
"baseline": {
"passing": true,
"evaluatedAt": "<string>",
"failingChecks": [
"<string>"
]
},
"declaredRequirements": [
"<string>"
]
},
"window": {
"hours": 4503599627370495,
"startedAt": "<string>",
"endedAt": "<string>"
},
"generatedAt": "<string>"
},
"debugGrant": {
"grantUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expiresAt": "2023-11-07T05:31:56Z"
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Get a client Source's health as its agent operator
Returns the source health object for one client Source your sales agent powers, through a live binding the client still authorizes; activation is not required. The object is operator-scoped: it offers no actions, replaces client- and Apostra-owned failure text with a generic sentence, does not name what the client has to decide for an operation waiting on them, and returns writes as null. Attempt bodies are withheld unless the client’s debug grant for this Source is active, which debugGrant reports. Requires an organization administrator with Partner operating access.
A valid request URL is required to generate request examples{
"sourceHealth": {
"identity": {
"sellerAccount": {
"id": "<string>",
"name": "<string>"
},
"source": {
"id": "<string>",
"sourceId": "<string>",
"name": "<string>",
"executionType": "<string>"
},
"agent": {
"id": "<string>",
"name": "<string>",
"observedRevision": "<string>"
},
"routing": {
"eligible": true,
"setupComplete": true,
"willReceiveRequest": true,
"reasonCodes": [
"<string>"
],
"setupSteps": [
{
"id": "currency",
"scope": "seller_account",
"action": {
"kind": "open",
"label": "<string>"
}
}
]
}
},
"health": [
{
"operation": "get_products",
"supported": true,
"status": "healthy",
"condition": "timeout",
"lastOkAt": "<string>",
"lastFailureAt": "<string>",
"lastFailure": "<string>",
"owner": "seller",
"window": {
"calls": 4503599627370495,
"succeeded": 4503599627370495,
"failed": 4503599627370495,
"timedOut": 4503599627370495
},
"findingIds": [
"<string>"
]
}
],
"writes": [
{
"taskKind": "media_buy",
"attempts": 4503599627370495,
"succeeded": 4503599627370495,
"failed": 4503599627370495,
"open": 4503599627370495,
"neverAnswered": 4503599627370495,
"oldestOpenAt": "<string>",
"topFailure": {
"errorCode": "<string>",
"recovery": "transient",
"count": 4503599627370495
},
"owner": "seller"
}
],
"diagnosis": {
"severity": "blocking",
"owner": "seller",
"findings": [
{
"id": "<string>",
"code": "<string>",
"operation": "get_products",
"owner": "seller",
"severity": "blocking",
"summary": "<string>",
"detail": "<string>",
"action": {
"kind": "recheck",
"label": "<string>",
"operation": "refresh_esa",
"pathParams": {}
},
"docsAnchor": "<string>",
"observedAt": "<string>",
"evidence": {
"operation": "get_products",
"window": {
"startedAt": "<string>",
"endedAt": "<string>"
},
"target": "widget_evidence"
},
"unresolvableCreativeFormats": [
{
"productId": "<string>",
"formats": [
{
"id": "<string>",
"agentUrl": "<string>"
}
]
}
]
}
]
},
"operations": [
{
"id": "<string>",
"operation": "get_products",
"subject": {
"kind": "<string>",
"id": "<string>",
"revision": 0
},
"state": "open",
"settlement": "response",
"startedAt": "<string>",
"settledAt": "<string>",
"owner": "seller",
"waitingOn": {
"party": "seller",
"since": "<string>",
"target": {
"kind": "approval",
"id": "<string>"
},
"nextAction": {
"tool": "open_media_buy_timeline",
"arguments": {}
}
},
"attempts": [
{
"attemptNumber": 4503599627370495,
"startedAt": "<string>",
"completedAt": "<string>",
"outcome": "started",
"condition": "timeout",
"httpStatus": 0,
"latencyMs": 4503599627370495,
"errorCode": "<string>",
"recovery": "transient",
"handoff": {
"taskId": "<string>",
"debugId": "<string>",
"idempotencyKey": "<string>",
"traceId": "<string>"
},
"bodies": {
"state": "visible",
"request": "<string>",
"response": "<string>"
}
}
]
}
],
"operationsTruncated": true,
"liveEvidence": {
"useCases": [
{
"useCaseId": "<string>",
"status": "failing",
"lastPassedAt": "<string>",
"failingCheck": {
"check": "<string>",
"owner": "seller",
"action": {
"kind": "recheck",
"label": "<string>",
"operation": "refresh_esa",
"pathParams": {}
}
}
}
],
"baseline": {
"passing": true,
"evaluatedAt": "<string>",
"failingChecks": [
"<string>"
]
},
"declaredRequirements": [
"<string>"
]
},
"window": {
"hours": 4503599627370495,
"startedAt": "<string>",
"endedAt": "<string>"
},
"generatedAt": "<string>"
},
"debugGrant": {
"grantUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expiresAt": "2023-11-07T05:31:56Z"
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Path Parameters
Query Parameters
Response
Get a client Source's health as its agent operator
One client source health object as the agent operator that powers the source may read it. No action is offered, seller- and Apostra-owned failure text is generic, an operation waiting on the seller does not name what the seller decides, writes are null, and attempt bodies are withheld unless the seller has granted debug access to this source.