Get rulebook usage

Reports what depends on one rulebook, so you can see the effect of changing or deleting it.

• Access: an alpha-enabled API key with the MANAGE_RULEBOOKS permission.
• Returns: workflowCount, findingsTotal, the projects involved, and hasActiveWorkflowRun.
• Scope: the counts cover your own work only. A colleague's runs against the same shared template are not included.

Path Parameters

Response Body

curl -X GET "https://example.com/api/v1alpha1/rulebooks/rb_0190b5d4-7e1f-7a2b-9c3d-1234567890ab/usage" \  -H "Authorization: Bearer $DEEPFRAME_API_KEY"

{  "findings_total": 3,  "has_active_workflow_run": false,  "projects": [    {      "finding_count": 3,      "name": "warehouse-shift-01.mp4",      "source_id": "vid_0190b5d4-7e1f-7a2b-9c3d-1234567890ab"    }  ],  "rulebook_id": "rb_0190b5d4-7e1f-7a2b-9c3d-1234567890ab",  "workflow_count": 1}