Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.activeprospect.com/llms.txt

Use this file to discover all available pages before exploring further.

A ping limit counter keeps track of the number of pings counted against the ping limit. The counter has the same ID as the ping limit configuration saved with the flow. Most of the properties of the ping limit configuration are available on the ping limit counter, as a convenience.

​
id
string
read-only

24 character alpha-numeric BSON identifier

Pattern: ^[0-9a-fA-F]{24}$
Example:

"6402715c40926f93753580d9"

​
name
string

The human-readable name of the ping limit

​
failed_count
integer

The number of leads that failed during the current interval

​
flow_id
string
read-only

24 character alpha-numeric BSON identifier

Pattern: ^[0-9a-fA-F]{24}$
Example:

"5fd4371e940df5a34a3888b2"

​
source_id
string
read-only

The entity of the flow source if the limit is set on a source

Pattern: ^[0-9a-fA-F]{24}$
Example:

"5fd4371e940df5a34a3888b2"

​
maximum
integer

The number of pings that will be accepted

​
duration
integer

The number duration_units the ping limit persists for

​
duration_units
string

The unit of time the ping limit persists for: minute, hour, day, week, or month

​
time_zone
string

The time zone in which ping limit resets

Example:

"America/New_York"

​
started_at
string<date-time>
read-only

Read-only time the ping limit interval started

​
expires_at
string<date-time>
read-only

Read-only time the ping limit interval ends