List events whose deliveries are held past the monthly delivery allowance
curl --request GET \
--url https://app.hookie.ai/admin/api/projects/{pid}/deliveries/heldconst options = {method: 'GET'};
fetch('https://app.hookie.ai/admin/api/projects/{pid}/deliveries/held', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/admin/api/projects/{pid}/deliveries/held"
response = requests.get(url)
print(response.text){
"holds": [
{
"event_id": "<string>",
"dataset": "<string>",
"destinations": 123,
"period": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"limit": 123,
"offset": 123,
"allowance": {
"used": 123,
"quota": 123,
"ceiling": 123
}
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>"
}Deliveries
List events whose deliveries are held past the monthly delivery allowance
Past the plan’s delivery ceiling the fan-out stores the event as usual and HOLDS its remaining destinations: one hold per event, oldest first. Nothing is dropped; release them with POST …/deliveries/held/release once there is room.
GET
/
admin
/
api
/
projects
/
{pid}
/
deliveries
/
held
List events whose deliveries are held past the monthly delivery allowance
curl --request GET \
--url https://app.hookie.ai/admin/api/projects/{pid}/deliveries/heldconst options = {method: 'GET'};
fetch('https://app.hookie.ai/admin/api/projects/{pid}/deliveries/held', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/admin/api/projects/{pid}/deliveries/held"
response = requests.get(url)
print(response.text){
"holds": [
{
"event_id": "<string>",
"dataset": "<string>",
"destinations": 123,
"period": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"limit": 123,
"offset": 123,
"allowance": {
"used": 123,
"quota": 123,
"ceiling": 123
}
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>"
}Path Parameters
Query Parameters
Required range:
1 <= x <= 100Required range:
x >= 0