Docs
Ads

An ad account's spending limit

GEThttps://api.norreach.app/v1/ad-accounts/{id}/spending-limit

The ad account's own spending limit and the spend counted against it since the last reset, read live from the network, in minor units of the account's currency. At the limit the network stops every ad in the account. Meta accounts; other networks answer 422 ad_network_unsupported.

ads:readOperation id: get_ad_account_spending_limit
GET/ad-accounts/{id}/spending-limit
curl -X GET "https://api.norreach.app/v1/ad-accounts/{id}/spending-limit" \
  -H "Authorization: Bearer $NORREACH_API_KEY"
An ad account's spending limit
{
  "object": "ad_account_spending_limit",
  "ad_account_id": "7d8e9f0a-1b2c-4d3e-8f4a-5b6c7d8e9f0a",
  "network": "meta",
  "currency": "SEK",
  "limit": {
    "amount_minor": 5000000,
    "currency": "SEK"
  },
  "spent": {
    "amount_minor": 1254000,
    "currency": "SEK"
  },
  "level": "ok"
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope ads:read. API keys and scopes

Path parameters

idstring (uuid)pathrequired

An id (UUID).

Response

200application/json— An ad account's spending limit

object"ad_account_spending_limit"required
ad_account_idstring (uuid)required

An id (UUID).

networkenumrequired
One of:metatiktokredditchatgpt
currencystring | nullrequired
limitobject | nullrequired

Null = no account spending limit.

spentobject | nullrequired

Spend counted against the limit since it was last reset.

levelenumrequired

near from 80 % of the limit; at reached the network stops every ad in the account.

One of:noneoknearreachedunknown

Errors

Errors are application/problem+json with a stable code.

StatusCodeMeaning
400bad_requestThe request couldn't be read.
400unknown_fieldThe request has a field this operation doesn't know.
401unauthorizedA valid API key is required.
403insufficient_scopeThis API key doesn't have the scope this operation needs.
403feature_not_enabledThe API isn't switched on for this workspace.
404not_foundThat doesn't exist.
409conflictThat conflicts with the current state.
422ad_network_unsupportedThis can't be done on this ad network from NorReach yet.
429rate_limitedToo many requests. Slow down and try again.
500server_errorSomething went wrong on our side.
503unavailableThe API isn't available right now. Try again shortly.