API documentation

GET /buyer_ping_templates

Authorization Required

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

List buyer ping templates.

Returns every buyer ping template with its key, name, description, and the inputs and secrets a ping from it asks for.

Example Request

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

Example Response 200

{
  "buyer_ping_templates": [
    {
      "key": "33_mile_radius",
      "name": "33 Mile Radius",
      "description": "Ask 33 Mile Radius whether it supports the caller's zip code. On acceptance the call routes with 33 Mile Radius's amount as revenue and its duration.",
      "inputs": [],
      "secrets": [
        {
          "key": "password",
          "label": "Password",
          "hint": "The password from 33 Mile Radius's call API instructions. It is saved as a secret and never shown again."
        }
      ]
    },
    {
      "key": "accident_com",
      "name": "Accident.com",
      "description": "Send Accident.com the caller's phone number and email. The call routes only when Accident.com reports the lead is not a duplicate.",
      "inputs": [],
      "secrets": [
        {
          "key": "api_key",
          "label": "API key",
          "hint": "The api-key from Accident.com. It is saved as a secret and never shown again."
        },
        {
          "key": "api_secret",
          "label": "API secret",
          "hint": "The api-secret from Accident.com. It is saved as a secret and never shown again."
        }
      ]
    },
    {
      "key": "allcalls",
      "name": "AllCalls",
      "description": "Ask AllCalls whether an agent is online for the caller's vertical and location. The call routes to the buyer only when AllCalls answers that one is.",
      "inputs": [
        {
          "key": "affiliate_id",
          "label": "Affiliate ID",
          "hint": "The affiliate_id AllCalls issued to you."
        },
        {
          "key": "vertical",
          "label": "Vertical",
          "hint": "The vertical value AllCalls expects for this buyer, from its instructions."
        }
      ],
      "secrets": [
        {
          "key": "api_key",
          "label": "API key",
          "hint": "The api_key from AllCalls. It is saved as a secret and never shown again."
        }
      ]
    }
  ]
}