Caps

A cap allows limiting the number of leads sent to a flow. If a lead is successful, it will be counted against the maximum configured leads. If configured, the rule set will be evaluated to determine whether a lead will be counted against the cap.

List all caps

Get the counters for all active caps. Caps that haven't received lead traffic during the current interval will not be included.

Request
query Parameters
flow_id
string (ID) ^[0-9a-fA-F]{24}$
Responses
200

OK

get/caps
Request samples
curl -i -X GET \
  'https://app.leadconduit.com/caps?flow_id=string'
Response samples
application/json
[
  • {
    • "id": "string",
    • "cap_ids": [
      • "string"
      ],
    • "caps": [
      • { }
      ],
    • "count": 0,
    • "duration": 1,
    • "duration_units": "month",
    • "expires_at": "2020-11-23T11:41:52Z",
    • "failed_count": 0,
    • "flow_id": "string",
    • "maximum": 1200,
    • "name": "Monthly leads from TX",
    • "source_id": "string",
    • "started_at": "2020-11-23T11:41:52Z",
    • "step_id": "string",
    • "time_zone": "America/New_York",
    • "type": "volume",
    • "updated_at": "2020-11-23T11:41:52Z"
    }
]

Get a cap

Returns the cap associated to the ID

Request
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$

ID of the cap to get

Responses
200

OK

get/caps/{id}
Request samples
curl -i -X GET \
  https://app.leadconduit.com/caps/:id
Response samples
application/json
{
  • "id": "string",
  • "cap_ids": [
    • "string"
    ],
  • "caps": [
    • { }
    ],
  • "count": 0,
  • "duration": 1,
  • "duration_units": "month",
  • "expires_at": "2020-11-23T11:41:52Z",
  • "failed_count": 0,
  • "flow_id": "string",
  • "maximum": 1200,
  • "name": "Monthly leads from TX",
  • "source_id": "string",
  • "started_at": "2020-11-23T11:41:52Z",
  • "step_id": "string",
  • "time_zone": "America/New_York",
  • "type": "volume",
  • "updated_at": "2020-11-23T11:41:52Z"
}