Pinglimit

{
  "id": "5fd4371e940df5a34a3888b2",
  "name": "<string>",
  "maximum": 123,
  "duration": 123,
  "duration_units": "<string>",
  "time_zone": "America/New_York",
  "created_at": "2023-11-07T05:31:56Z"
}

The ping limit configuration is defined in a flow on a source, or directly on the flow itself. The configuration controls the behavior of the ping limit by setting the maximum and the duration. The counter for a ping limit is kept as a standalone record which shares ping limit's ID.

string

24 character alpha-numeric BSON identifier

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

Example:

"5fd4371e940df5a34a3888b2"

name

string

The human-readable name of the ping limit

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"

created_at

string<date-time>

Read-only time the ping limit was created

Cap counter Pinglimit counter

⌘I

API Documentation

Concepts