Get ad server source status

curl --request GET \
  --url https://api.interchange.io/api/v2/storefront/esa/{esaId}/status \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.interchange.io/api/v2/storefront/esa/{esaId}/status"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.interchange.io/api/v2/storefront/esa/{esaId}/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "operational": {
    "isLive": true,
    "discoveryDegraded": true,
    "deliveryDegraded": true,
    "summary": "<string>",
    "issues": [
      {
        "code": "<string>",
        "message": "<string>",
        "affects": [],
        "configurePath": "<string>"
      }
    ]
  },
  "adapter": {
    "type": "<string>",
    "connected": true,
    "lastTestedAt": "2023-11-07T05:31:56Z",
    "lastTestError": "<string>"
  },
  "syncs": {
    "inventory": {
      "status": "<string>",
      "severity": "ok",
      "lastSuccessAt": null,
      "issue": null,
      "lastRunAt": null,
      "lastStartedAt": null,
      "itemCount": null,
      "error": null,
      "history": {
        "recentRunCount": 0,
        "recentFailureCount": 0,
        "consecutiveFailureCount": 0,
        "latestFailureAt": null,
        "latestError": null
      }
    },
    "customTargeting": {
      "status": "<string>",
      "severity": "ok",
      "lastSuccessAt": null,
      "issue": null,
      "lastRunAt": null,
      "lastStartedAt": null,
      "itemCount": null,
      "error": null,
      "history": {
        "recentRunCount": 0,
        "recentFailureCount": 0,
        "consecutiveFailureCount": 0,
        "latestFailureAt": null,
        "latestError": null
      }
    },
    "advertisers": {
      "status": "<string>",
      "severity": "ok",
      "lastSuccessAt": null,
      "issue": null,
      "lastRunAt": null,
      "lastStartedAt": null,
      "itemCount": null,
      "error": null,
      "history": {
        "recentRunCount": 0,
        "recentFailureCount": 0,
        "consecutiveFailureCount": 0,
        "latestFailureAt": null,
        "latestError": null
      }
    },
    "reporting": {
      "status": "<string>",
      "severity": "ok",
      "lastSuccessAt": null,
      "issue": null,
      "lastRunAt": null,
      "lastStartedAt": null,
      "itemCount": null,
      "error": null,
      "history": {
        "recentRunCount": 0,
        "recentFailureCount": 0,
        "consecutiveFailureCount": 0,
        "latestFailureAt": null,
        "latestError": null
      }
    },
    "signalCoverage": {
      "status": "<string>",
      "severity": "ok",
      "lastSuccessAt": null,
      "issue": null,
      "lastRunAt": null,
      "lastStartedAt": null,
      "itemCount": null,
      "error": null,
      "history": {
        "recentRunCount": 0,
        "recentFailureCount": 0,
        "consecutiveFailureCount": 0,
        "latestFailureAt": null,
        "latestError": null
      }
    },
    "pricingAvailability": {
      "status": "<string>",
      "severity": "ok",
      "lastSuccessAt": null,
      "issue": null,
      "lastRunAt": null,
      "lastStartedAt": null,
      "itemCount": null,
      "error": null,
      "history": {
        "recentRunCount": 0,
        "recentFailureCount": 0,
        "consecutiveFailureCount": 0,
        "latestFailureAt": null,
        "latestError": null
      },
      "coverageSummary": {
        "totalProducts": 4503599627370495,
        "activeProducts": 4503599627370495,
        "adServerPriced": 4503599627370495,
        "manuallyPriced": 4503599627370495,
        "unresolved": 4503599627370495,
        "draftIgnored": 4503599627370495,
        "byUnresolvedReason": {}
      }
    }
  },
  "workflows": {
    "openCount": 0,
    "oldestOpenedAt": "2023-11-07T05:31:56Z",
    "byKind": {}
  },
  "packages": {
    "activeCount": 0,
    "pausedCount": 0,
    "last24hImpressions": 0
  },
  "creatives": {
    "activeCount": 0,
    "pendingReviewCount": 0,
    "rejectedLast24hCount": 0
  },
  "webhooks": {
    "last24h": {
      "delivered": 0,
      "failed": 0,
      "successRate": 123
    },
    "lastFailureAt": "2023-11-07T05:31:56Z"
  },
  "fetchedAt": "2023-11-07T05:31:56Z",
  "products": {
    "activeCount": 0,
    "draftCount": 0,
    "archivedCount": 0
  },
  "inventoryProfiles": {
    "totalCount": 0,
    "completeCount": 0,
    "incompleteCount": 0,
    "wholesaleOwnedCount": 0
  },
  "catalog": {
    "sourceCount": 4503599627370495,
    "sources": [
      {
        "storefrontId": "<string>",
        "storefrontPlatformId": "<string>",
        "storefrontName": "<string>",
        "sourceId": "<string>",
        "sourceName": "<string>"
      }
    ],
    "products": {
      "cachedItemCount": 4503599627370495,
      "sourceCount": 4503599627370495,
      "okSourceCount": 4503599627370495,
      "errorSourceCount": 4503599627370495,
      "unsupportedSourceCount": 4503599627370495,
      "missingSourceCount": 4503599627370495,
      "accountKeyCount": 4503599627370495,
      "lastFetchedAt": "2023-11-07T05:31:56Z",
      "lastWebhookAt": "2023-11-07T05:31:56Z",
      "oldestFetchedAt": "2023-11-07T05:31:56Z",
      "softExpired": true,
      "hardExpired": true,
      "errorCode": "<string>",
      "errorMessage": "<string>",
      "wholesaleFeedVersion": "<string>",
      "pricingVersion": "<string>"
    },
    "signals": {
      "cachedItemCount": 4503599627370495,
      "sourceCount": 4503599627370495,
      "okSourceCount": 4503599627370495,
      "errorSourceCount": 4503599627370495,
      "unsupportedSourceCount": 4503599627370495,
      "missingSourceCount": 4503599627370495,
      "accountKeyCount": 4503599627370495,
      "lastFetchedAt": "2023-11-07T05:31:56Z",
      "lastWebhookAt": "2023-11-07T05:31:56Z",
      "oldestFetchedAt": "2023-11-07T05:31:56Z",
      "softExpired": true,
      "hardExpired": true,
      "errorCode": "<string>",
      "errorMessage": "<string>",
      "wholesaleFeedVersion": "<string>",
      "pricingVersion": "<string>"
    }
  },
  "setupTasks": {
    "blockerCount": 0,
    "warningCount": 0,
    "items": [
      {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "isComplete": true,
        "configurePath": "<string>"
      }
    ]
  },
  "capabilities": {
    "reporting": {
      "checkedAt": "2023-11-07T05:31:56Z",
      "issue": {
        "code": "<string>",
        "category": "<string>",
        "message": "<string>",
        "retryable": true,
        "action": "<string>",
        "capability": "<string>"
      }
    },
    "forecasting": {
      "checkedAt": "2023-11-07T05:31:56Z",
      "issue": {
        "code": "<string>",
        "category": "<string>",
        "message": "<string>",
        "retryable": true,
        "action": "<string>",
        "capability": "<string>"
      }
    }
  },
  "diagnoses": [
    {
      "diagnosisId": "<string>",
      "sourceId": "<string>",
      "sourceName": "<string>",
      "summary": "<string>",
      "detail": "<string>",
      "action": {
        "kind": "recheck",
        "label": "<string>",
        "operation": "refresh_esa",
        "pathParams": {
          "esaId": "<string>"
        },
        "method": "POST",
        "path": "<string>"
      },
      "docsAnchor": "<string>",
      "observedAt": "<string>"
    }
  ]
}

{
  "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

esa

{esaId}

status

Get ad server source status

curl --request GET \
  --url https://api.interchange.io/api/v2/storefront/esa/{esaId}/status \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.interchange.io/api/v2/storefront/esa/{esaId}/status"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.interchange.io/api/v2/storefront/esa/{esaId}/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "operational": {
    "isLive": true,
    "discoveryDegraded": true,
    "deliveryDegraded": true,
    "summary": "<string>",
    "issues": [
      {
        "code": "<string>",
        "message": "<string>",
        "affects": [],
        "configurePath": "<string>"
      }
    ]
  },
  "adapter": {
    "type": "<string>",
    "connected": true,
    "lastTestedAt": "2023-11-07T05:31:56Z",
    "lastTestError": "<string>"
  },
  "syncs": {
    "inventory": {
      "status": "<string>",
      "severity": "ok",
      "lastSuccessAt": null,
      "issue": null,
      "lastRunAt": null,
      "lastStartedAt": null,
      "itemCount": null,
      "error": null,
      "history": {
        "recentRunCount": 0,
        "recentFailureCount": 0,
        "consecutiveFailureCount": 0,
        "latestFailureAt": null,
        "latestError": null
      }
    },
    "customTargeting": {
      "status": "<string>",
      "severity": "ok",
      "lastSuccessAt": null,
      "issue": null,
      "lastRunAt": null,
      "lastStartedAt": null,
      "itemCount": null,
      "error": null,
      "history": {
        "recentRunCount": 0,
        "recentFailureCount": 0,
        "consecutiveFailureCount": 0,
        "latestFailureAt": null,
        "latestError": null
      }
    },
    "advertisers": {
      "status": "<string>",
      "severity": "ok",
      "lastSuccessAt": null,
      "issue": null,
      "lastRunAt": null,
      "lastStartedAt": null,
      "itemCount": null,
      "error": null,
      "history": {
        "recentRunCount": 0,
        "recentFailureCount": 0,
        "consecutiveFailureCount": 0,
        "latestFailureAt": null,
        "latestError": null
      }
    },
    "reporting": {
      "status": "<string>",
      "severity": "ok",
      "lastSuccessAt": null,
      "issue": null,
      "lastRunAt": null,
      "lastStartedAt": null,
      "itemCount": null,
      "error": null,
      "history": {
        "recentRunCount": 0,
        "recentFailureCount": 0,
        "consecutiveFailureCount": 0,
        "latestFailureAt": null,
        "latestError": null
      }
    },
    "signalCoverage": {
      "status": "<string>",
      "severity": "ok",
      "lastSuccessAt": null,
      "issue": null,
      "lastRunAt": null,
      "lastStartedAt": null,
      "itemCount": null,
      "error": null,
      "history": {
        "recentRunCount": 0,
        "recentFailureCount": 0,
        "consecutiveFailureCount": 0,
        "latestFailureAt": null,
        "latestError": null
      }
    },
    "pricingAvailability": {
      "status": "<string>",
      "severity": "ok",
      "lastSuccessAt": null,
      "issue": null,
      "lastRunAt": null,
      "lastStartedAt": null,
      "itemCount": null,
      "error": null,
      "history": {
        "recentRunCount": 0,
        "recentFailureCount": 0,
        "consecutiveFailureCount": 0,
        "latestFailureAt": null,
        "latestError": null
      },
      "coverageSummary": {
        "totalProducts": 4503599627370495,
        "activeProducts": 4503599627370495,
        "adServerPriced": 4503599627370495,
        "manuallyPriced": 4503599627370495,
        "unresolved": 4503599627370495,
        "draftIgnored": 4503599627370495,
        "byUnresolvedReason": {}
      }
    }
  },
  "workflows": {
    "openCount": 0,
    "oldestOpenedAt": "2023-11-07T05:31:56Z",
    "byKind": {}
  },
  "packages": {
    "activeCount": 0,
    "pausedCount": 0,
    "last24hImpressions": 0
  },
  "creatives": {
    "activeCount": 0,
    "pendingReviewCount": 0,
    "rejectedLast24hCount": 0
  },
  "webhooks": {
    "last24h": {
      "delivered": 0,
      "failed": 0,
      "successRate": 123
    },
    "lastFailureAt": "2023-11-07T05:31:56Z"
  },
  "fetchedAt": "2023-11-07T05:31:56Z",
  "products": {
    "activeCount": 0,
    "draftCount": 0,
    "archivedCount": 0
  },
  "inventoryProfiles": {
    "totalCount": 0,
    "completeCount": 0,
    "incompleteCount": 0,
    "wholesaleOwnedCount": 0
  },
  "catalog": {
    "sourceCount": 4503599627370495,
    "sources": [
      {
        "storefrontId": "<string>",
        "storefrontPlatformId": "<string>",
        "storefrontName": "<string>",
        "sourceId": "<string>",
        "sourceName": "<string>"
      }
    ],
    "products": {
      "cachedItemCount": 4503599627370495,
      "sourceCount": 4503599627370495,
      "okSourceCount": 4503599627370495,
      "errorSourceCount": 4503599627370495,
      "unsupportedSourceCount": 4503599627370495,
      "missingSourceCount": 4503599627370495,
      "accountKeyCount": 4503599627370495,
      "lastFetchedAt": "2023-11-07T05:31:56Z",
      "lastWebhookAt": "2023-11-07T05:31:56Z",
      "oldestFetchedAt": "2023-11-07T05:31:56Z",
      "softExpired": true,
      "hardExpired": true,
      "errorCode": "<string>",
      "errorMessage": "<string>",
      "wholesaleFeedVersion": "<string>",
      "pricingVersion": "<string>"
    },
    "signals": {
      "cachedItemCount": 4503599627370495,
      "sourceCount": 4503599627370495,
      "okSourceCount": 4503599627370495,
      "errorSourceCount": 4503599627370495,
      "unsupportedSourceCount": 4503599627370495,
      "missingSourceCount": 4503599627370495,
      "accountKeyCount": 4503599627370495,
      "lastFetchedAt": "2023-11-07T05:31:56Z",
      "lastWebhookAt": "2023-11-07T05:31:56Z",
      "oldestFetchedAt": "2023-11-07T05:31:56Z",
      "softExpired": true,
      "hardExpired": true,
      "errorCode": "<string>",
      "errorMessage": "<string>",
      "wholesaleFeedVersion": "<string>",
      "pricingVersion": "<string>"
    }
  },
  "setupTasks": {
    "blockerCount": 0,
    "warningCount": 0,
    "items": [
      {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "isComplete": true,
        "configurePath": "<string>"
      }
    ]
  },
  "capabilities": {
    "reporting": {
      "checkedAt": "2023-11-07T05:31:56Z",
      "issue": {
        "code": "<string>",
        "category": "<string>",
        "message": "<string>",
        "retryable": true,
        "action": "<string>",
        "capability": "<string>"
      }
    },
    "forecasting": {
      "checkedAt": "2023-11-07T05:31:56Z",
      "issue": {
        "code": "<string>",
        "category": "<string>",
        "message": "<string>",
        "retryable": true,
        "action": "<string>",
        "capability": "<string>"
      }
    }
  },
  "diagnoses": [
    {
      "diagnosisId": "<string>",
      "sourceId": "<string>",
      "sourceName": "<string>",
      "summary": "<string>",
      "detail": "<string>",
      "action": {
        "kind": "recheck",
        "label": "<string>",
        "operation": "refresh_esa",
        "pathParams": {
          "esaId": "<string>"
        },
        "method": "POST",
        "path": "<string>"
      },
      "docsAnchor": "<string>",
      "observedAt": "<string>"
    }
  ]
}

{
  "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": {}
  }
}

Authorizations

Authorization

string

header

required

API key or access token

Path Parameters

esaId

integer

required

Ad server source connection id. The wire field remains esaId for API compatibility.

Required range: 1 <= x <= 9007199254740991

Example:

123

Query Parameters

includeSyncHistory

boolean

syncHistoryLimit

integer

default:5

Required range: 1 <= x <= 10

Response

Get ad server source status

Operational snapshot of a managed ad-server source: adapter health, sync state, workflows, packages, creatives, webhook stats.

operational

object

required

Derived private uptime-style state for a managed ad-server source. Local provisioning state is lifecycle bookkeeping; this status is computed from upstream status at read time.

Show child attributes

adapter

object

required

Show child attributes

syncs

object

required

Show child attributes

workflows

object

required

Show child attributes

packages

object

required

Show child attributes

creatives

object

required

Show child attributes

webhooks

object | null

required

Show child attributes

fetchedAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

wholesalePricingMode

enum<string>

Legacy source-level pricing preference. Inspect syncs.pricingAvailability.coverageSummary for effective per-product coverage.

Available options:

ad_server_sync,

manual_upload

products

object

Sellable wholesale-product rollup. Optional for backward compatibility with upstream builds before the rollup shipped.

Show child attributes

inventoryProfiles

object

Reusable inventory-profile ingredient rollup from the managed source. Separate from products, which counts sellable wholesale products.

Show child attributes

catalog

object

Local view of whether managed-source product/signal catalog webhooks are landing and refreshing buyer discovery caches.

Show child attributes

setupTasks

object

Configuration-completeness rollup from the upstream managed-source status. Storefront merges these with its own platform-managed task list.

Show child attributes

capabilities

object

Durable state for separately provisioned ad-server capabilities. A capability awaiting vendor permission remains paused until explicitly re-checked.

Show child attributes

diagnoses

object[]

Typed ad-server-scoped source-health diagnoses (sync + catalog failure modes), computed by the same rules as readiness diagnoses. Only seller-owned entries are tasks; scope3/vendor-owned entries are informational.

Show child attributes

Reactivate an ad server source List ad server source sync history

⌘I