Traffic Source Rate Limits Manage per-traffic-source rate limit entries.

GET /api/v1/traffic_source_rate_limits
List all traffic source rate limits.

Params

Param name
Description
Validations
ids
Optional

Return records matching these ids.

Validations:

  • Must be an array of decimal values. EG: [0, 1, 2, 3]
page
Optional

Return the next page of results.

Validations:

  • Must be a number.
per_page
Optional

How many results to return per page. The default is 25.

Validations:

  • Must be a number.
created_at_to
Optional

Date formatted like 2016-01-01 12:25:15 -0500

Validations:

  • Must be a String
created_at_from
Optional

Date formatted like 2016-01-01 12:25:15 -0500

Validations:

  • Must be a String
fulltext
Optional

Search for any record that matches this text

Validations:

  • Must be a String
time_zone
Optional

Date ranges will be parsed using this time zone.

Validations:
columns
Optional
Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at

Must be any combination of:

  • id
  • legacy_id
  • type
  • uuid
  • created_at
  • updated_at
  • deleted_at
  • user_updated_at
  • routes_show_path
  • routes_edit_path
  • external_record_id
  • company_id
  • traffic_source_rate_limiter_id
  • traffic_source_id
  • rate_limit_per_minute
  • rate_limit_per_hour
  • rate_limit_per_day
  • sortable_order
  • traffic_source_name
  • user_traffic_source_id

Validations:

  • Must be a String
root
Optional

Pass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}

Validations:

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

GET /api/v1/traffic_source_rate_limits/new
Build a new traffic source rate limit.

Params

Param name
Description
Validations
traffic_source_rate_limiter_id
Required

The parent rate limiter group ID.

Validations:

  • Must be a number.
traffic_source_id
Optional Blank Value Allowed

The traffic source ID.

Validations:

  • Must be a number.

POST /api/v1/traffic_source_rate_limits
Create a traffic source rate limit.

Params

Param name
Description
Validations
traffic_source_rate_limiter_id
Required

The parent rate limiter group ID.

Validations:

  • Must be a number.
traffic_source_id
Required

The traffic source ID.

Validations:

  • Must be a number.
rate_limit_per_minute
Optional Blank Value Allowed

Maximum pings per minute for this traffic source.

Validations:

  • Must be a number.
rate_limit_per_hour
Optional Blank Value Allowed

Maximum pings per hour for this traffic source.

Validations:

  • Must be a number.
rate_limit_per_day
Optional Blank Value Allowed

Maximum pings per day for this traffic source.

Validations:

  • Must be a number.

GET /api/v1/traffic_source_rate_limits/:id
Show a traffic source rate limit.

PUT /api/v1/traffic_source_rate_limits/:id
Update a traffic source rate limit.

Params

Param name
Description
Validations
traffic_source_id
Optional Blank Value Allowed

The traffic source ID.

Validations:

  • Must be a number.
rate_limit_per_minute
Optional Blank Value Allowed

Maximum pings per minute for this traffic source.

Validations:

  • Must be a number.
rate_limit_per_hour
Optional Blank Value Allowed

Maximum pings per hour for this traffic source.

Validations:

  • Must be a number.
rate_limit_per_day
Optional Blank Value Allowed

Maximum pings per day for this traffic source.

Validations:

  • Must be a number.

DELETE /api/v1/traffic_source_rate_limits/:id
Delete a traffic source rate limit.