Cap counter

{
  "duration": 1,
  "duration_units": "month",
  "maximum": 1200,
  "type": "volume",
  "cap_ids": [
    "5fd4371e940df5a34a3888b2"
  ],
  "caps": [
    {
      "type": "volume",
      "name": "Monthly leads from TX",
      "maximum": 1200,
      "duration": 2,
      "duration_units": "month",
      "rule_set": {
        "op": "and",
        "rules": [
          {
            "lhv": "lead.state",
            "op": "is equal to",
            "rhv": "TX",
            "rule_set": "<unknown>"
          }
        ]
      },
      "caps": "<array>",
      "time_zone": "America/New_York",
      "reason": "<string>",
      "created_at": "2020-11-23T11:41:52Z"
    }
  ],
  "count": 123,
  "expires_at": "2020-11-23T11:41:52Z",
  "failed_count": 123,
  "name": "Monthly leads from TX",
  "started_at": "2020-11-23T11:41:52Z",
  "time_zone": "America/New_York",
  "updated_at": "2020-11-23T11:41:52Z"
}

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

duration

number

required

The number duration_units for which the cap persists

Required range: x >= 1

Example:

1

duration_units

enum<string>

required

The unit of time for which the cap persists

Available options:

month,

week,

day,

hour,

minute

maximum

number

required

The number of successful leads that will be accepted

Example:

1200

type

enum<string>

required

The type of this cap (LeadConduit may eventually support different types of caps)

Available options:

volume

cap_ids

string[]

24 character alpha-numeric BSON identifier

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

caps

object[]

Nested caps evaluated if rules for the parent cap pass

Show child attributes

count

integer

The number of successful leads during the current interval

expires_at

string<date-time>

Read-only time the cap interval ends

Example:

"2020-11-23T11:41:52Z"

failed_count

integer

The number of leads that failed because the cap was reached during the current interval

name

string

The human-readable name of the cap

Example:

"Monthly leads from TX"

started_at

string<date-time>

Read-only time the cap interval started

Example:

"2020-11-23T11:41:52Z"

time_zone

string

The time zone in which cap resets

Example:

"America/New_York"

updated_at

string<date-time>

Example:

"2020-11-23T11:41:52Z"

Cap Pinglimit

API Documentation

Concepts