Get directed-campaign subscription health (alpha)

Authorizations

Authorization

string

header

required

API key or access token

Path Parameters

connectionId

integer<int64>

required

Storefront connection ID

accountId

integer<int64>

required

Storefront connection account ID

Response

Get directed-campaign subscription health (alpha)

Durable provider-account subscription and its read-only mirror health.

string

required

customerId

integer

required

Required range: 1 <= x <= 9007199254740991

advertiserId

string

required

connectionId

string

required

accountId

string

required

sourceId

string

required

providerType

string

required

status

enum<string>

required

Available options:

ACTIVE,

PAUSED,

ERROR

backfillStart

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))$

lastSyncedAt

string<date-time> | null

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))$

lastSyncStatus

enum<string> | null

required

Available options:

SUCCESS,

ERROR

lastSyncError

enum<string> | null

required

Fixed safe reconciliation summary. Provider messages and identifiers are never persisted or returned.

Available options:

Connected provider account could not be synchronized.

errorCode

enum<string> | null

required

Machine-readable diagnosis of the most recent failed periodic sweep. Stable Scope3 service error code; null after a successful sweep. Provider messages and request identifiers are never returned.

Available options:

NOT_FOUND,

ACCESS_DENIED,

VALIDATION_ERROR,

INVALID_REQUEST,

CONFLICT,

INTERNAL_ERROR,

RATE_LIMITED,

SERVICE_UNAVAILABLE,

FEATURE_NOT_ENABLED,

PRICING_NOT_CONFIGURED,

CURRENCY_MISMATCH,

INSUFFICIENT_MEDIA_BUDGET,

ROUTED_AGENT_REQUIRES_OPERATOR_AUTH,

ADAPTER_STOREFRONT_REQUIRES_ROUTED_CAMPAIGN,

CAPABILITY_NOT_SUPPORTED,

SELLER_APPROVAL_REQUIRED,

SALES_AGENT_NOT_ACTIVE,

CREDIT_LIMIT_EXCEEDED,

FX_QUOTE_EXPIRED,

FX_RATE_UNAVAILABLE

errorField

enum<string> | null

required

Allowlisted request field associated with the most recent failed sweep, when one is safe to expose; null after success.

Available options:

account.account_id,

accountId,

advertiserId,

assets,

assets.post.identity_id,

brief,

buying_mode,

clicks,

format_id,

impressions,

instagram_actor_id,

liveConformance.account,

liveConformance.inventory,

liveConformance.pagination,

liveConformance.providerInventory,

mediaBuy.canceled,

mediaBuys.account,

mediaBuys.currency,

mediaBuys.envelope,

mediaBuys.identity,

mediaBuys.lifecycle,

mediaBuys.numeric,

mediaBuys.packages,

mediaBuys.revision,

mediaBuys.retirement,

mediaBuys.schedule,

page_id,

sourceId,

spend,

spotify.ads.identity,

spotify.ads.rejectReasons,

spotify.ads.status

errorReason

enum<string> | null

required

Allowlisted machine-readable reconciliation reason from the most recent failed sweep; null after success.

Available options:

account_scope_mismatch,

catalog_shape_invalid,

cleanup_readback_mismatch,

create_account_mismatch,

delegated_auth_unready,

delivery_reconciliation_mismatch,

lifecycle_readback_mismatch,

missing_identity,

nested_subdivision_hierarchy_unproven,

pagination_incomplete,

pagination_page_bound_exceeded,

pagination_deadline_exceeded,

pagination_response_malformed,

pagination_list_malformed,

pagination_page_info_missing,

pagination_counters_invalid,

pagination_page_mismatch,

pagination_page_size_mismatch,

pagination_bounds_exceeded,

pagination_totals_inconsistent,

pagination_totals_changed,

pagination_page_count_mismatch,

pagination_page_oversized,

pagination_identity_invalid,

pagination_duplicate_identity,

pagination_terminal_confirmation_mismatch,

pagination_collected_count_mismatch,

provider_response_malformed,

readback_mismatch,

scope_insufficient,

selected_account_mismatch

upstreamCode

enum<string> | null

required

Allowlisted provider error category from the most recent failed sweep; null after success. Raw provider messages, request IDs, and resource IDs are excluded.

Available options:

ACCOUNT_NOT_AUTHORIZED,

ACCOUNT_NOT_FOUND,

ACCOUNT_SCOPE_MISMATCH,

ADVERTISER_INFO_DENIED,

ADVERTISER_INFO_MALFORMED,

AMBIGUOUS_AUDIENCE_DETAIL,

AUDIENCE_DETAIL_ID_MISMATCH,

AUTH_REQUIRED,

CATALOG_SCOPE_MISMATCH,

CONFIGURATION_ERROR,

INCOMPLETE_PAGINATION,

INVALID_AUDIENCE_DETAIL,

INVALID_AUDIENCE_INVENTORY,

INVALID_AUDIENCE_RESPONSE,

INVALID_ADVERTISER_SCOPE,

INVALID_PROVIDER_RESPONSE,

INVALID_REQUEST,

INVALID_SELECTED_ACCOUNT,

INVALID_SUCCESS_ENVELOPE,

NETWORK_ERROR,

NOT_FOUND,

OWNERSHIP_MISMATCH,

PERMISSION_DENIED,

PLATFORM_ERROR,

POLICY_VIOLATION,

RATE_LIMIT,

RATE_LIMITED,

SCOPE_INSUFFICIENT,

SERVICE_UNAVAILABLE,

SNAP_ME_MALFORMED,

TIMEOUT,

UPSTREAM_BAD_GATEWAY,

UPSTREAM_HTTP_ERROR,

UPSTREAM_NON_JSON,

UPSTREAM_UNAVAILABLE,

VALIDATION_ERROR

lastPresenceSyncedAt

string<date-time> | null

required

When the tracked-presence sweep (audiences and event sources) last visited this subscription; null until the first presence sweep runs.

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))$

lastPresenceSyncStatus

enum<string> | null

required

Outcome of the most recent tracked-presence sweep. SKIPPED means the sweep visited the subscription but presence discovery did not apply (for example, the feature is not enabled for this customer); null until the first sweep.

Available options:

SUCCESS,

ERROR,

SKIPPED

lastPresenceSyncError

string | null

required

Bounded, sanitized summary of the most recent presence sweep failure or skip reason; null after a fully successful sweep. Provider messages and identifiers are never returned.

createdAt

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))$

updatedAt

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))$

archivedAt

string<date-time> | null

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))$