Skip to main content

DataSourceCredential

An official-API or vendor credential of the account. Secrets are write-only: masked shows •••• and, for values longer than 12 characters, the last 4.

idinteger
providerstring

Possible values: [youtube_api, instagram_graph, reddit, apify]

labelstring
is_enabledboolean
masked object

youtube_api: api_key; instagram_graph: access_token, business_account_id; reddit: client_id, client_secret; apify: token

property name*string
last_used_at(string | null)<date-time>nullable
last_errorstring | nullnullable

Last credential problem an actor run or probe reported (refused token, quota); cleared by a good answer or a new secret

last_error_at(string | null)<date-time>nullable
priorityinteger

Order the provider's keys are tried in, lower first (PATCH /api/v3/data-sources/priorities)

healthstring

exhausted: quota or credit used up (until exhausted_until, or re-checked every 10 minutes when the reset is unknown); invalid: refused (re-checked every 10 minutes too); cooldown: transient errors, until cooldown_until (15 min doubling, at most 6 h). A key that is not ok is skipped by failover/round robin and comes back on its own when a probe succeeds

Possible values: [ok, exhausted, invalid, cooldown]

health_reasonstring | nullnullable
exhausted_until(string | null)<date-time>nullable

Known quota reset: vendor usage cycle end, YouTube Data API midnight America/Los_Angeles

cooldown_until(string | null)<date-time>nullable
consecutive_failuresinteger
last_checked_at(string | null)<date-time>nullable

Last probe

usage object | null

What the last probe said: { used, limit, unit: USD, reset_at }

usednumber
limitnumber | nullnullable
unitstring
reset_at(string | null)<date-time>nullable
created_atstring<date-time>
updated_atstring<date-time>
DataSourceCredential
{
"id": 0,
"provider": "youtube_api",
"label": "string",
"is_enabled": true,
"masked": {},
"last_used_at": "2024-07-29T15:51:28.071Z",
"last_error": "string",
"last_error_at": "2024-07-29T15:51:28.071Z",
"priority": 0,
"health": "ok",
"health_reason": "string",
"exhausted_until": "2024-07-29T15:51:28.071Z",
"cooldown_until": "2024-07-29T15:51:28.071Z",
"consecutive_failures": 0,
"last_checked_at": "2024-07-29T15:51:28.071Z",
"usage": "Unknown Type: object,null",
"created_at": "2024-07-29T15:51:28.071Z",
"updated_at": "2024-07-29T15:51:28.071Z"
}