Skip to content

Zapier

Flat, polling-shaped reads for automation tools. The Beket Zapier app is built on these, and any integrator may use them. A per-key rate limit applies. Beta like the rest of the API, but the Zapier app depends on these shapes, so they change only by adding fields.

GET /zapier/audits

Your organization’s live audits as id/label pairs, for a dropdown.

Terminal window
curl "https://api.beket.ai/api/v1/zapier/audits?limit=LIMIT" \
-H "Authorization: Bearer $BEKET_API_KEY"
NameInRequiredTypeDescription
limitquerynointegerRows to return, newest first. Defaults to 100; a value above 100 is a 400.
FieldTypeRequiredDescription
successbooleanyes
dataobject[]yes
data[].idstringyes
data[].namestringyes
data[].subjectstringyes
data[].mode“brand” | “market”yes
{
"success": true,
"data": [
{
"id": "clrecorderaudit0000000001",
"name": "Example Co",
"subject": "example.com",
"mode": "brand"
}
]
}

GET /zapier/me

The organization this key belongs to, and the key’s name. Cheap and side-effect free: use it to test a connection.

Terminal window
curl "https://api.beket.ai/api/v1/zapier/me" \
-H "Authorization: Bearer $BEKET_API_KEY"
FieldTypeRequiredDescription
successbooleanyes
dataobjectyes
data.orgIdstringyes
data.orgNamestringyes
data.keyNamestring | nullyes
{
"success": true,
"data": {
"orgId": "00000000-0000-4000-8000-00000000e001",
"orgName": "Recorder Fixture",
"keyName": "Recorder"
}
}

GET /zapier/runs

Completed runs with their headline numbers and a report link. Only the last 7 days are returned, newest first — poll it and dedupe on id. An auditId that is not a live audit of your organization is a 404, never an empty list, so a poll cannot silently watch nothing. Responses are Cache-Control: private, no-store.

Terminal window
curl "https://api.beket.ai/api/v1/zapier/runs?auditId=AUDIT_ID&limit=LIMIT" \
-H "Authorization: Bearer $BEKET_API_KEY"
NameInRequiredTypeDescription
auditIdquerynostringOnly this audit. A malformed id is a 400; an id that is not a live audit of your organization is a 404.
limitquerynointegerRows to return, newest first. Defaults to 50; a value above 100 is a 400.
FieldTypeRequiredDescription
successbooleanyes
dataobject[]yes
data[].idstringyesThe snapshot id — the event’s dedupe key.
data[].auditIdstringyes
data[].auditNamestringyes
data[].subjectstringyesThe domain for a brand audit, the topic for a market audit.
data[].runType“full” | “short”yes
data[].completedAtstringyes
data[].aiVisibilitynumber | nullyes
data[].shareOfVoicenumber | nullyes
data[].topCompetitorsstring[]yesCompetitor names, highest share first.
data[].reportUrlstringyes
{
"success": true,
"data": [
{
"id": "00000000-0000-4000-8000-00000000e102",
"auditId": "clrecorderaudit0000000001",
"auditName": "Example Co",
"subject": "example.com",
"runType": "full",
"completedAt": "2026-10-25T19:53:04.851Z",
"aiVisibility": 0.62,
"shareOfVoice": 0.6,
"topCompetitors": [
"Rival"
],
"reportUrl": "https://app.beket.ai/audit/clrecorderaudit0000000001/report"
}
]
}

GET /zapier/signals

Signals first seen recently — a new competitor, a lost citation, a metric swing — flattened to one row each. Dismissed signals are left out. Only the last 7 days are returned, newest first — poll it and dedupe on id. An auditId that is not a live audit of your organization is a 404, never an empty list, so a poll cannot silently watch nothing. Responses are Cache-Control: private, no-store.

Terminal window
curl "https://api.beket.ai/api/v1/zapier/signals?auditId=AUDIT_ID&kind=KIND" \
-H "Authorization: Bearer $BEKET_API_KEY"
NameInRequiredTypeDescription
auditIdquerynostringOnly this audit. A malformed id is a 400; an id that is not a live audit of your organization is a 404.
kindqueryno“new_competitor” | “entity_disappeared” | “new_citation_source” | “metric_delta” | “edge_blocked_crawler”Only signals of this kind.
limitquerynointegerRows to return, newest first. Defaults to 50; a value above 100 is a 400.
FieldTypeRequiredDescription
successbooleanyes
dataobject[]yes
data[].idstringyes
data[].auditIdstringyes
data[].auditNamestringyes
data[].kind“new_competitor” | “entity_disappeared” | “new_citation_source” | “metric_delta” | “edge_blocked_crawler”yes
data[].kindLabelstringyes
data[].titlestringyesThe same words the report shows for this signal.
data[].firstSeenAtstringyes
data[].state“open” | “resolved”yes
data[].reportUrlstringyes
{
"success": true,
"data": [
{
"id": "clrecordersignal000000001",
"auditId": "clrecorderaudit0000000001",
"auditName": "Example Co",
"kind": "new_competitor",
"kindLabel": "New competitor",
"title": "Rival started appearing in AI answers",
"firstSeenAt": "2026-10-25T19:53:04.852Z",
"state": "open",
"reportUrl": "https://app.beket.ai/audit/clrecorderaudit0000000001/report?section=competitors"
}
]
}