Getting a list of country targeting rules

📘 Information below might be outdated - please visit our recently updated API Reference

The instruction below shows how to get a list of country targeting rules for a URL.

1) Get your API key here: https://app.short.io/settings/integrations/api-key

• Click "Create API key".
• Add a Secret key.

2) Copy an ID of a short link you want to get a list of country targeting rules.

• Open the statistics of the short link.
• Copy the link ID.

3) Install prerequisites for requests.

Python

pip install requests

Node.js

npm install @short.io/client-node

Now everything is ready to run the following snippet. It will get a list of country targeting rules for a URL.

4) Create a file: filename.py/ .js/ .rb. Use the code snippet below.

📘

Please, replace link_idString with an appropriate value.

Python

import requests

url = "https://api.short.io/link_country/link_idString"

headers = {
    'accept': "application/json",
    'authorization': "<<apiKey>>"
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

Node.js

import { setApiKey, getLinkCountries } from "@short.io/client-node";

setApiKey("<<apiKey>>");

const result = await getLinkCountries({
  path: { linkId: "LINK_ID" }
});

console.log(result.data);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.short.io/link_country/LINK_ID")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["authorization"] = '<<apiKey>>'

response = http.request(request)
puts response.read_body

5) Launch the file.

Python

python filename.py

Node.js

node filename.js

Ruby

ruby filename.rb

6) JSON Response (list of country targeting rules).

Once you run the code, you will see the response.

[
  {
    id: 24151,
    country: 'GA',
    originalURL: 'https://toolbox.googleapps.com/apps/dig/#CAA/',
    createdAt: '2020-06-01T10:37:18.000Z',
    updatedAt: '2020-06-01T10:37:18.000Z',
    link_idString: "lnk_49n_UcaN"
  }
]