PingLimits

A ping limit allows limiting the number of pings sent to a flow. Both successful and failed pings will be counted against the maximum configured pings.

List all ping limits

Get the counters for all active ping limits. Ping limits that haven't received ping traffic during the current interval will not be included.

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

Return the ping limits where flow_id matches this value

Responses
200

OK

get/ping_limits
Request samples
curl -i -X GET \
  'https://app.leadconduit.com/ping_limits?flow_id=string'
Response samples
application/json
[
  • {
    • "id": "string",
    • "name": "string",
    • "maximum": 0,
    • "duration": 0,
    • "duration_units": "string",
    • "time_zone": "string",
    • "created_at": "2019-08-24T14:15:22Z"
    }
]

Fetch a ping limit

Get a counter for a single ping limit.

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

The ID of the specific Ping Limit

Responses
200

OK

get/ping_limits/{id}
Request samples
curl -i -X GET \
  https://app.leadconduit.com/ping_limits/:id
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "maximum": 0,
  • "duration": 0,
  • "duration_units": "string",
  • "time_zone": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}