API documentation

GET /traffic_source_rate_limiters

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/traffic_source_rate_limiters

List all traffic source rate limiters.

Lists the reusable rate limit configurations that can be attached to traffic sources to cap how many leads or calls they can send in a given period.

Params

Param name	Description
ids Optional	Return records matching these ids. Must be an array of decimal values. EG: `[0, 1, 2, 3]`
page Optional	Return the next page of results. Must be a number.
per_page Optional	How many results to return per page. The default is 25. Must be a number.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Must be a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Must be a String
fulltext Optional	Search for any record that matches this text Must be a String
time_zone Optional	Date ranges will be parsed using this time zone. Must be a valid time zone. See the list of valid time zones.
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 name description traffic_source_rate_limits_count 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: {}}` Must be a boolean value: 1, true, yes, on, 0, false, no, off

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/traffic_source_rate_limiters/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "traffic_source_rate_limiters": [
    {
      "id": 10001,
      "type": "TrafficSourceRateLimiter",
      "uuid": null,
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": null,
      "routes_edit_path": "/traffic_source_rate_limiters/10001/edit",
      "external_record_id": null,
      "company_id": 10002,
      "name": "High Volume Partner Limits",
      "description": "Looser throttling for high-volume partner traffic sources",
      "traffic_source_rate_limits_count": null
    },
    {
      "id": 10003,
      "type": "TrafficSourceRateLimiter",
      "uuid": null,
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": null,
      "routes_edit_path": "/traffic_source_rate_limiters/10003/edit",
      "external_record_id": null,
      "company_id": 10002,
      "name": "Standard Ping/Post Limits",
      "description": "Per-source throttling for the standard ping/post inbound webhook",
      "traffic_source_rate_limits_count": null
    }
  ],
  "metadata": {
    "root": "traffic_source_rate_limiters",
    "page": 1,
    "total_pages": 1,
    "per_page": 2,
    "total_count": 2,
    "next_cursor": 10004
  }
}

GET /traffic_source_rate_limiters/new

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/traffic_source_rate_limiters/new

Build a new traffic source rate limiter.

Builds a new traffic source rate limiter with default attributes without saving it.

Params

Param name	Description
name Optional Blank value allowed	Name Must be a String
description Optional Blank value allowed	Description Must be a String

Param name

Description

name
Optional Blank value allowed

Name

Must be a String

description
Optional Blank value allowed

Description

Must be a String

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/traffic_source_rate_limiters/new' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "traffic_source_rate_limiter": {
    "id": null,
    "type": "TrafficSourceRateLimiter",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": null,
    "routes_edit_path": null,
    "external_record_id": null,
    "company_id": 10001,
    "name": "Traffic Source Rate Limiter",
    "description": null,
    "traffic_source_rate_limits_count": 0
  },
  "metadata": {
    "root": "traffic_source_rate_limiter"
  }
}

POST /traffic_source_rate_limiters

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/traffic_source_rate_limiters

Create a traffic source rate limiter.

Creates a reusable rate limiter configuration, with a name and description, that can later be attached to one or more traffic sources.

Params

Param name	Description
name Required	Name Must be a String
description Optional Blank value allowed	Description Must be a String

Param name

Description

name
Required

Name

Must be a String

description
Optional Blank value allowed

Description

Must be a String

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/traffic_source_rate_limiters/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Example Traffic Source Rate Limiter",
  "description": "Per-source throttling for the standard ping/post inbound webhook."
}'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "traffic_source_rate_limiter": {
    "id": 10001,
    "type": "TrafficSourceRateLimiter",
    "uuid": null,
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": null,
    "routes_edit_path": "/traffic_source_rate_limiters/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "name": "Example Traffic Source Rate Limiter",
    "description": "Per-source throttling for the standard ping/post inbound webhook.",
    "traffic_source_rate_limits_count": 0
  },
  "metadata": {
    "root": "traffic_source_rate_limiter"
  }
}

GET /traffic_source_rate_limiters/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/traffic_source_rate_limiters/:id

Show a traffic source rate limiter.

Retrieves a traffic source rate limiter by id.

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/traffic_source_rate_limiters/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "traffic_source_rate_limiter": {
    "id": 10001,
    "type": "TrafficSourceRateLimiter",
    "uuid": null,
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": null,
    "routes_edit_path": "/traffic_source_rate_limiters/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "name": "High Volume Partner Limits",
    "description": "Looser throttling for high-volume partner traffic sources",
    "traffic_source_rate_limits_count": 0
  },
  "metadata": {
    "root": "traffic_source_rate_limiter"
  }
}

PUT /traffic_source_rate_limiters/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/traffic_source_rate_limiters/:id

Update a traffic source rate limiter.

Updates a rate limiter's name or description.

Params

Param name	Description
name Optional Blank value allowed	Name Must be a String
description Optional Blank value allowed	Description Must be a String

Param name

Description

name
Optional Blank value allowed

Name

Must be a String

description
Optional Blank value allowed

Description

Must be a String

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/traffic_source_rate_limiters/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "description": "Per-source throttling for the standard ping/post inbound webhook (updated)."
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "traffic_source_rate_limiter": {
    "id": 10001,
    "type": "TrafficSourceRateLimiter",
    "uuid": null,
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": null,
    "routes_edit_path": "/traffic_source_rate_limiters/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "name": "Example Traffic Source Rate Limiter",
    "description": "Per-source throttling for the standard ping/post inbound webhook (updated).",
    "traffic_source_rate_limits_count": 0
  },
  "metadata": {
    "root": "traffic_source_rate_limiter"
  }
}

DELETE /traffic_source_rate_limiters/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/traffic_source_rate_limiters/:id

Delete a traffic source rate limiter.

Deletes a rate limiter configuration.

Example Request

curl -X DELETE 'https://[your-subdomain].trackdrive.com/api/v1/traffic_source_rate_limiters/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "traffic_source_rate_limiter": {
    "id": 10001,
    "type": "TrafficSourceRateLimiter",
    "uuid": null,
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": "2026-01-15T15:30:00.000Z",
    "user_updated_at": null,
    "routes_show_path": null,
    "routes_edit_path": "/traffic_source_rate_limiters/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "name": "Example Traffic Source Rate Limiter",
    "description": "Per-source throttling for the standard ping/post inbound webhook.",
    "traffic_source_rate_limits_count": 0
  },
  "metadata": {
    "root": "traffic_source_rate_limiter"
  }
}

Params

Must be any combination of:

Params

Params

Params