API documentation

GET /traffic_source_rate_limits

Authorization Required

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

List all traffic source rate limits.

Lists the per-traffic-source rate limit entries defined under a rate limiter group, ordered by their configured sortable order.

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 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 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_limits/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "traffic_source_rate_limits": [
    {
      "id": 10001,
      "type": "TrafficSourceRateLimit",
      "uuid": null,
      "created_at": "2026-01-15T14:30:00.000Z",
      "updated_at": "2026-01-15T14:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": null,
      "routes_edit_path": "/traffic_source_rate_limits/10001/edit",
      "external_record_id": null,
      "company_id": 10002,
      "traffic_source_rate_limiter_id": 10003,
      "traffic_source_id": 10004,
      "rate_limit_per_minute": 10,
      "rate_limit_per_hour": 250,
      "rate_limit_per_day": 1000,
      "sortable_order": -2,
      "traffic_source_name": null,
      "user_traffic_source_id": null
    },
    {
      "id": 10005,
      "type": "TrafficSourceRateLimit",
      "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_limits/10005/edit",
      "external_record_id": null,
      "company_id": 10002,
      "traffic_source_rate_limiter_id": 10006,
      "traffic_source_id": 10007,
      "rate_limit_per_minute": 10,
      "rate_limit_per_hour": 250,
      "rate_limit_per_day": 1000,
      "sortable_order": -2,
      "traffic_source_name": null,
      "user_traffic_source_id": null
    }
  ],
  "metadata": {
    "root": "traffic_source_rate_limits",
    "page": 1,
    "total_pages": 5,
    "per_page": 2,
    "total_count": 10,
    "next_cursor": 10008
  }
}

GET /traffic_source_rate_limits/new

Authorization Required

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

Build a new traffic source rate limit.

Returns a blank rate limit entry for the given traffic_source_rate_limiter_id, without saving it.

Params

Param name

Description

traffic_source_rate_limiter_id
Required

The parent rate limiter group ID.

Must be a number.

traffic_source_id
Optional

The traffic source ID.

Must be a number.

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/traffic_source_rate_limits/new?traffic_source_rate_limiter_id=10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "traffic_source_rate_limit": {
    "id": null,
    "type": "TrafficSourceRateLimit",
    "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": 10002,
    "traffic_source_rate_limiter_id": 10001,
    "traffic_source_id": null,
    "rate_limit_per_minute": null,
    "rate_limit_per_hour": null,
    "rate_limit_per_day": null,
    "sortable_order": null,
    "traffic_source_name": null,
    "user_traffic_source_id": null
  },
  "metadata": {
    "root": "traffic_source_rate_limit"
  }
}

POST /traffic_source_rate_limits

Authorization Required

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

Create a traffic source rate limit.

Creates a rate limit entry that caps how many pings a specific traffic source may send per minute, hour, and/or day within a parent rate limiter group. A traffic source may only have one entry per rate limiter.

Params

Param name	Description
traffic_source_rate_limiter_id Required	The parent rate limiter group ID. Must be a number.
traffic_source_id Required	The traffic source ID. Must be a number.
rate_limit_per_minute Optional	Maximum pings per minute for this traffic source. Must be a number.
rate_limit_per_hour Optional	Maximum pings per hour for this traffic source. Must be a number.
rate_limit_per_day Optional	Maximum pings per day for this traffic source. Must be a number.

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/traffic_source_rate_limits/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "traffic_source_rate_limiter_id": 10001,
  "traffic_source_id": 10002,
  "rate_limit_per_minute": 5,
  "rate_limit_per_hour": 100,
  "rate_limit_per_day": 500
}'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "traffic_source_rate_limit": {
    "id": 10003,
    "type": "TrafficSourceRateLimit",
    "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_limits/10003/edit",
    "external_record_id": null,
    "company_id": 10004,
    "traffic_source_rate_limiter_id": 10001,
    "traffic_source_id": 10002,
    "rate_limit_per_minute": 5,
    "rate_limit_per_hour": 100,
    "rate_limit_per_day": 500,
    "sortable_order": -1,
    "traffic_source_name": "Zoe Kim TikTok Ads - Insurance",
    "user_traffic_source_id": "tiktok_insurance"
  },
  "metadata": {
    "root": "traffic_source_rate_limit"
  }
}

GET /traffic_source_rate_limits/:id

Authorization Required

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

Show a traffic source rate limit.

Fetches a single traffic source rate limit entry by id.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "traffic_source_rate_limit": {
    "id": 10001,
    "type": "TrafficSourceRateLimit",
    "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_limits/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "traffic_source_rate_limiter_id": 10003,
    "traffic_source_id": 10004,
    "rate_limit_per_minute": 10,
    "rate_limit_per_hour": 250,
    "rate_limit_per_day": 1000,
    "sortable_order": -2,
    "traffic_source_name": null,
    "user_traffic_source_id": null
  },
  "metadata": {
    "root": "traffic_source_rate_limit"
  }
}

PUT /traffic_source_rate_limits/:id

Authorization Required

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

Update a traffic source rate limit.

Updates a traffic source rate limit entry's per-minute, per-hour, or per-day caps.

Params

Param name	Description
traffic_source_rate_limiter_id Optional Blank value allowed	The parent rate limiter group ID. Must be a number.
traffic_source_id Optional	The traffic source ID. Must be a number.
rate_limit_per_minute Optional	Maximum pings per minute for this traffic source. Must be a number.
rate_limit_per_hour Optional	Maximum pings per hour for this traffic source. Must be a number.
rate_limit_per_day Optional	Maximum pings per day for this traffic source. Must be a number.

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/traffic_source_rate_limits/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "rate_limit_per_minute": 10
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "traffic_source_rate_limit": {
    "id": 10001,
    "type": "TrafficSourceRateLimit",
    "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_limits/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "traffic_source_rate_limiter_id": 10003,
    "traffic_source_id": 10004,
    "rate_limit_per_minute": 10,
    "rate_limit_per_hour": 100,
    "rate_limit_per_day": 500,
    "sortable_order": -1,
    "traffic_source_name": "Zoe Kim TikTok Ads - Insurance",
    "user_traffic_source_id": "tiktok_insurance"
  },
  "metadata": {
    "root": "traffic_source_rate_limit"
  }
}

DELETE /traffic_source_rate_limits/:id

Authorization Required

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

Delete a traffic source rate limit.

Deletes a traffic source rate limit entry by id, removing that traffic source's override from the rate limiter group.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "traffic_source_rate_limit": {
    "id": 10001,
    "type": "TrafficSourceRateLimit",
    "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_limits/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "traffic_source_rate_limiter_id": 10003,
    "traffic_source_id": 10004,
    "rate_limit_per_minute": 5,
    "rate_limit_per_hour": 100,
    "rate_limit_per_day": 500,
    "sortable_order": -1,
    "traffic_source_name": "Zoe Kim TikTok Ads - Insurance",
    "user_traffic_source_id": "tiktok_insurance"
  },
  "metadata": {
    "root": "traffic_source_rate_limit"
  }
}

Params

Must be any combination of:

Params

Params

Params