Caps

Read caps

Caps and consumption for a campaign's suppliers and buyers.

Both path segments are optional: omit target for every entry in a scope, and omit both for every supplier and buyer at once. Entries are not grouped by scope, so a page can interleave the two.

used is measured rather than stored, and as_of says when.

get/v2/campaigns/{campaign}/caps/{scope}/{target}

Request

  • Base URL: https://api.leadprosper.io/public
  • URL: https://api.leadprosper.io/public/v2/campaigns/{campaign}/caps/{scope}/{target}
  • Auth: one of:
    • HTTP bearer
    • API key in query parameter api_token

Path parameters

campaigninteger required

Campaign id.

scope'suppliers' | 'buyers' | 'global'

suppliers, buyers, or global on filters. Omit to cover every scope.

targetinteger

One supplier or buyer id. Omit to cover all of them within the scope.

Query parameters

limitinteger

Entries per page.

search_afterstring

The search_after value from the previous page. Omit for the first page.

Response

Success

statusstring

Changes

No recorded changes to this operation across all 1 revision of this API.