ClickCease ClickCease™ API Documentation | ClickCease

ClickCease™ API Documentation

Introduction

Welcome to the ClickCease™ API Documentation. The ClickCease™ API is organized around REST. Our API has:

  • predictable resource-oriented URLs

  • accepts form-encoded request bodies

  • returns JSON-encoded responses

  • and uses standard HTTP response codes

  • authentication


Choose from the language dropdown to see the code examples in your development language.

If you have any questions, we're happy to respond. Just send us a message at the bottom right.

Errors

ClickCease™ uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g. a required parameter was omitted). Codes in the 5xx range indicate an error with ClickCease's servers (rare).

HTTP status code summary

200

Everything went OK

400

Bad Request -- General client error, possibly malformed data

401

Unauthorized -- The API Key was not authorised (or no API Key was found)

409

Conflict -- An object with these parameters already exist (e.g. an API Key with the same name)

500

Server errors -- something went wrong with ClickCease's servers

Block an IP

Blocks a single or multiple IP Addresses

POST https://api.clickcease.com/api/domain/block-ip
Example Request
                            
                                    curl --location --request POST "https://api.clickcease.com/api/domain/block-ip/{INSERT-YOUR-API-KEY-HERE}" \
                                    --header "Content-Type: application/json" \
                                    --data "{\"domain\":\"your-domain.com\",\"ips\":[\"117.72.37.18\",\"117.72.39.*\",\"152.982.725.0/22\"]}"
                            
                        
                            
                                    var settings = {
                                        "url": "https://api.clickcease.com/api/domain/block-ip/{INSERT-YOUR-API-KEY-HERE}",
                                        "method": "POST",
                                        "timeout": 0,
                                        "headers": {
                                            "Content-Type": "application/json"
                                          },
                                        "data": "{\"domain\":\"your-domain.com\",\"ips\":[\"117.72.37.18\",\"117.72.39.*\",\"152.982.725.0/22\"]}",
                                      };
                                      $.ajax(settings).done(function (response) {
                                        console.log(response);
                                      });
                            
                        
                            
                                    require "uri"
                                    require "net/http"
                                    
                                    url = URI("https://api.clickcease.com/api/domain/block-ip/{INSERT-YOUR-API-KEY-HERE}")
                                    
                                    http = Net::HTTP.new(url.host, url.port)
                                    
                                    request = Net::HTTP::Post.new(url)
                                    request["Content-Type"] = "application/json"
                                    request.body = "{\"domain\":\"your-domain.com\",\"ips\":[\"117.72.37.18\",\"117.72.39.*\",\"152.982.725.0/22\"]}"
                                    
                                    response = http.request(request)
                                    puts response.read_body
                            
                        
                            
                                    import requests
                                    url = 'https://api.clickcease.com/api/domain/block-ip/{INSERT-YOUR-API-KEY-HERE}'
                                    payload = "{\"domain\":\"your-domain.com\",\"ips\":[\"117.72.37.18\",\"117.72.39.*\",\"152.982.725.0/22\"]}"
                                    headers = {
                                        'Content-Type': 'application/json'
                                      }
                                    response = requests.request('POST', url, headers = headers, data = payload, allow_redirects=False, timeout=undefined, allow_redirects=false)
                                    print(response.text)
                            
                        
                            
                                    var http = require('http');

                                    var options = {
                                      'method': 'POST',
                                      'hostname': 'api.clickcease.com',
                                      'path': '/api/domain/block-ip/{INSERT-YOUR-API-KEY-HERE}',
                                      'headers': {
                                        "Content-Type": "application/json"
                                      }
                                    };
                                    
                                    var req = http.request(options, function (res) {
                                      var chunks = [];
                                    
                                      res.on("data", function (chunk) {
                                        chunks.push(chunk);
                                      });
                                    
                                      res.on("end", function (chunk) {
                                        var body = Buffer.concat(chunks);
                                        console.log(body.toString());
                                      });
                                    
                                      res.on("error", function (error) {
                                        console.error(error);
                                      });
                                    });
                                    
                                    var postData =  "{\"domain\":\"your-domain.com\",\"ips\":[\"117.72.37.18\",\"117.72.39.*\",\"152.982.725.0/22\"]}";
                                    
                                    req.write(postData);
                                    
                                    req.end();
                            
                        
                                
                                        <?php

                                        $curl = curl_init();
                                        
                                        curl_setopt_array($curl, array(
                                          CURLOPT_URL => "https://api.clickcease.com/api/domain/block-ip/{INSERT-YOUR-API-KEY-HERE}",
                                          CURLOPT_RETURNTRANSFER => true,
                                          CURLOPT_ENCODING => "",
                                          CURLOPT_MAXREDIRS => 10,
                                          CURLOPT_TIMEOUT => 0,
                                          CURLOPT_FOLLOWLOCATION => false,
                                          CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
                                          CURLOPT_CUSTOMREQUEST => "POST",
                                          CURLOPT_POSTFIELDS =>"{\"domain\":\"your-domain.com\",\"ips\":[\"117.72.37.18\",\"117.72.39.*\",\"152.982.725.0/22\"]}",
                                          CURLOPT_HTTPHEADER => array(
                                            "Content-Type: application/json"
                                          ),
                                        ));
                                        
                                        $response = curl_exec($curl);
                                        $err = curl_error($curl);
                                        
                                        curl_close($curl);
                                        
                                        if ($err) {
                                          echo "cURL Error #:" . $err;
                                        } else {
                                          echo $response;
                                        } ?>
                                
                        
                                
                                        package main

                                        import (
                                          "fmt"
                                          "strings"
                                          "os"
                                          "path/filepath"
                                          "net/http"
                                          "io/ioutil"
                                        )
                                        
                                        func main() {
                                        
                                          url := "https://api.clickcease.com/api/domain/block-ip/{INSERT-YOUR-API-KEY-HERE}"
                                          method := "POST"
                                        
                                          payload := strings.NewReader("{\"domain\":\"your-domain.com\",\"ips\":[\"117.72.37.18\",\"117.72.39.*\",\"152.982.725.0/22\"]}")
                                        
                                          client := &http.Client {
                                            CheckRedirect: func(req *http.Request, via []*http.Request) error {
                                              return http.ErrUseLastResponse
                                            },
                                          }
                                          req, err := http.NewRequest(method, url, payload)
                                        
                                          if err != nil {
                                            fmt.Println(err)
                                          }

                                          req.Header.Add("Content-Type", "application/json")
                                          
                                          res, err := client.Do(req)
                                          defer res.Body.Close()
                                          body, err := ioutil.ReadAll(res.Body)
                                        
                                          fmt.Println(string(body))
                                        }
                                
                        

Unblock an IP

Unblocks a single or multiple IP Addresses

POST https://api.clickcease.com/api/domain/unblock-ip
Example Request
                            
                                    curl --location --request POST "https://api.clickcease.com/api/domain/unblock-ip/{INSERT-YOUR-API-KEY-HERE}" \
  --header "Content-Type: application/json" \
  --data "{\"domain\":\"your-domain.com\",\"ips\":[\"12.232.12.33\",\"52.232.123.*\",\"62.232.123.0/24\"]}"
                            
                        
                            
                                    var settings = {
                                        "url": "https://api.clickcease.com/api/domain/unblock-ip/{INSERT-YOUR-API-KEY-HERE}",
                                        "method": "POST",
                                        "timeout": 0,
                                        "headers": {
                                          "Content-Type": "application/json"
                                        },
                                        "data": "{\"domain\":\"your-domain.com\",\"ips\":[\"12.232.12.33\",\"52.232.123.*\",\"62.232.123.0/24\"]}",
                                      };
                                      $.ajax(settings).done(function (response) {
                                        console.log(response);
                                      });
                            
                        
                        
                                require "uri"
                                require "net/http"
                                
                                url = URI("https://api.clickcease.com/api/domain/block-ip/{INSERT-YOUR-API-KEY-HERE}")
                                
                                http = Net::HTTP.new(url.host, url.port)
                                
                                request = Net::HTTP::Post.new(url)
                                request.body = "{\"domain\":\"your-domain.com\",\"ips\":[\"117.72.37.18\",\"117.72.39.*\",\"152.982.725.0/22\"]}"
                                
                                response = http.request(request)
                                puts response.read_body
                        
                    
                        
                                import requests
                                url = 'https://api.clickcease.com/api/domain/unblock-ip/{INSERT-YOUR-API-KEY-HERE}'
                                payload = "{\"domain\":\"your-domain.com\",\"ips\":[\"12.232.12.33\",\"52.232.123.*\",\"62.232.123.0/24\"]}"
                                headers = {
                                  'Content-Type': 'application/json'
                                }
                                response = requests.request('POST', url, headers = headers, data = payload, allow_redirects=False, timeout=undefined, allow_redirects=false)
                                print(response.text)
                        
                    
                        
                                var http = require('http');

                                var options = {
                                  'method': 'POST',
                                  'hostname': 'api.clickcease.com',
                                  'path': '/api/domain/unblock-ip/{INSERT-YOUR-API-KEY-HERE}',
                                  'headers': {
                                    'Content-Type': 'application/json'
                                  }
                                };
                                
                                var req = http.request(options, function (res) {
                                  var chunks = [];
                                
                                  res.on("data", function (chunk) {
                                    chunks.push(chunk);
                                  });
                                
                                  res.on("end", function (chunk) {
                                    var body = Buffer.concat(chunks);
                                    console.log(body.toString());
                                  });
                                
                                  res.on("error", function (error) {
                                    console.error(error);
                                  });
                                });
                                
                                var postData =  "{\"domain\":\"your-domain.com\",\"ips\":[\"12.232.12.33\",\"52.232.123.*\",\"62.232.123.0/24\"]}";
                                
                                req.write(postData);
                                
                                req.end();
                        
                    
                            
                                    <?php

                                    $curl = curl_init();
                                    
                                    curl_setopt_array($curl, array(
                                      CURLOPT_URL => "https://api.clickcease.com/api/domain/unblock-ip/{INSERT-YOUR-API-KEY-HERE}",
                                      CURLOPT_RETURNTRANSFER => true,
                                      CURLOPT_ENCODING => "",
                                      CURLOPT_MAXREDIRS => 10,
                                      CURLOPT_TIMEOUT => 0,
                                      CURLOPT_FOLLOWLOCATION => false,
                                      CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
                                      CURLOPT_CUSTOMREQUEST => "POST",
                                      CURLOPT_POSTFIELDS =>"{\"domain\":\"your-domain.com\",\"ips\":[\"12.232.12.33\",\"52.232.123.*\",\"62.232.123.0/24\"]}",
                                      CURLOPT_HTTPHEADER => array(
                                        "Content-Type: application/json"
                                      ),
                                    ));
                                    
                                    $response = curl_exec($curl);
                                    $err = curl_error($curl);
                                    
                                    curl_close($curl);
                                    
                                    if ($err) {
                                      echo "cURL Error #:" . $err;
                                    } else {
                                      echo $response;
                                    } ?>
                            
                    
                            
                                    package main

                                    import (
                                      "fmt"
                                      "strings"
                                      "os"
                                      "path/filepath"
                                      "net/http"
                                      "io/ioutil"
                                    )
                                    
                                    func main() {
                                    
                                      url := "https://api.clickcease.com/api/domain/unblock-ip/{INSERT-YOUR-API-KEY-HERE}"
                                      method := "POST"
                                    
                                      payload := strings.NewReader("{\"domain\":\"your-domain.com\",\"ips\":[\"12.232.12.33\",\"52.232.123.*\",\"62.232.123.0/24\"]}")
                                    
                                      client := &http.Client {
                                        CheckRedirect: func(req *http.Request, via []*http.Request) error {
                                          return http.ErrUseLastResponse
                                        },
                                      }
                                      req, err := http.NewRequest(method, url, payload)
                                    
                                      if err != nil {
                                        fmt.Println(err)
                                      }
                                      req.Header.Add("Content-Type", "application/json")
                                    
                                      res, err := client.Do(req)
                                      defer res.Body.Close()
                                      body, err := ioutil.ReadAll(res.Body)
                                    
                                      fmt.Println(string(body))
                                    }
                            
                    

Get Blocked IPs

Gets a list of blocked IP addresses, the reason they were blocked, and the time the IP clicked

POST https://api.clickcease.com/api/domain/get-blocked-ips
Example Request
                                    
                                            curl --location --request POST "https://api.clickcease.com/api/domain/get-blocked-ips/{INSERT-YOUR-API-KEY-HERE}" \
                                            --header "Content-Type: application/json" \
                                            --data "{\"domain\":\"your-domain.com\"}"
                                    
                                
                                    
                                            var settings = {
                                                "url": "https://api.clickcease.com/api/domain/get-blocked-ips/{INSERT-YOUR-API-KEY-HERE}",
                                                "method": "POST",
                                                "timeout": 0,
                                                "headers": {
                                                  "Content-Type": "application/json"
                                                },
                                                "data": "{\"domain\":\"your-domain.com\"}",
                                              };
                                              $.ajax(settings).done(function (response) {
                                                console.log(response);
                                              });
                                    
                                
                                    
                                            require "uri"
                                            require "net/http"
                                            
                                            url = URI("https://api.clickcease.com/api/domain/get-blocked-ips/{INSERT-YOUR-API-KEY-HERE}")
                                            
                                            http = Net::HTTP.new(url.host, url.port)
                                            
                                            request = Net::HTTP::Post.new(url)
                                            request["Content-Type"] = "application/json"
                                            request.body = "{\"domain\":\"your-domain.com\"}"
                                            
                                            response = http.request(request)
                                            puts response.read_body
                                    
                                
                                    
                                            import requests
                                            url = 'https://api.clickcease.com/api/domain/get-blocked-ips/{INSERT-YOUR-API-KEY-HERE}'
                                            payload = "{\"domain\":\"your-domain.com\"}"
                                            headers = {
                                              'Content-Type': 'application/json'
                                            }
                                            response = requests.request('POST', url, headers = headers, data = payload, allow_redirects=False, timeout=undefined, allow_redirects=false)
                                            print(response.text)
                                    
                                
                                    
                                            var http = require('http');

                                            var options = {
                                              'method': 'POST',
                                              'hostname': 'api.clickcease.com',
                                              'path': '/api/domain/get-blocked-ips/{INSERT-YOUR-API-KEY-HERE}',
                                              'headers': {
                                                'Content-Type': 'application/json'
                                              }
                                            };
                                            
                                            var req = http.request(options, function (res) {
                                              var chunks = [];
                                            
                                              res.on("data", function (chunk) {
                                                chunks.push(chunk);
                                              });
                                            
                                              res.on("end", function (chunk) {
                                                var body = Buffer.concat(chunks);
                                                console.log(body.toString());
                                              });
                                            
                                              res.on("error", function (error) {
                                                console.error(error);
                                              });
                                            });
                                            
                                            var postData =  "{\"domain\":\"your-domain.com\"}";
                                            
                                            req.write(postData);
                                            
                                            req.end();
                                    
                                
                                        
                                                <?php

                                                $curl = curl_init();
                                                
                                                curl_setopt_array($curl, array(
                                                  CURLOPT_URL => "https://api.clickcease.com/api/domain/get-blocked-ips/{INSERT-YOUR-API-KEY-HERE}",
                                                  CURLOPT_RETURNTRANSFER => true,
                                                  CURLOPT_ENCODING => "",
                                                  CURLOPT_MAXREDIRS => 10,
                                                  CURLOPT_TIMEOUT => 0,
                                                  CURLOPT_FOLLOWLOCATION => false,
                                                  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
                                                  CURLOPT_CUSTOMREQUEST => "POST",
                                                  CURLOPT_POSTFIELDS =>"{\"domain\":\"your-domain.com\"}",
                                                  CURLOPT_HTTPHEADER => array(
                                                    "Content-Type: application/json"
                                                  ),
                                                ));
                                                
                                                $response = curl_exec($curl);
                                                $err = curl_error($curl);
                                                
                                                curl_close($curl);
                                                
                                                if ($err) {
                                                  echo "cURL Error #:" . $err;
                                                } else {
                                                  echo $response;
                                                } ?>
                                        
                                
                        
                                package main

                                import (
                                    "fmt"
                                    "strings"
                                    "os"
                                    "path/filepath"
                                    "net/http"
                                    "io/ioutil"
                                )
                                
                                func main() {
                                
                                    url := "https://api.clickcease.com/api/domain/get-blocked-ips/{INSERT-YOUR-API-KEY-HERE}"
                                    method := "POST"
                                
                                    payload := strings.NewReader("{\"domain\":\"your-domain.com\"}")
                                
                                    client := &http.Client {
                                    CheckRedirect: func(req *http.Request, via []*http.Request) error {
                                        return http.ErrUseLastResponse
                                    },
                                    }
                                    req, err := http.NewRequest(method, url, payload)
                                
                                    if err != nil {
                                    fmt.Println(err)
                                    }
                                    req.Header.Add("Content-Type", "application/json")
                                
                                    res, err := client.Do(req)
                                    defer res.Body.Close()
                                    body, err := ioutil.ReadAll(res.Body)
                                
                                    fmt.Println(string(body))
                                }
                        
                
Example Response
                    
                            {  
                                "blocked":[  
                                   {  
                                      "ip":"118.12.34.*",
                                      "block_reason":"ManuallyBlocked",
                                      "click_date":"2022-01-29T09:56:28"
                                   },
                                   {  
                                      "ip":"127.12.57.19",
                                      "block_reason":"ManuallyBlocked",
                                      "click_date":"2022-01-29T09:56:28"
                                   }
                                ]
                             }
                    
                

AdSpy Create Keyword

Creates a new keyword in AdSpy

POST https://api.clickcease.com/api/domain/adspy-create-keyword
Example Request
                        
                                curl --location --request POST "https://api.clickcease.com/api/domain/adspy-create-keyword/{INSERT-YOUR-API-KEY-HERE}" \
                                --header "Content-Type: application/json" \
                                --data "{\"domain\":\"your-domain.com\",\"keyword\":\"is in none\",\"country\":1,\"device\":1}"
                        
                    
                        
                                var settings = {
                                    "url": "https://api.clickcease.com/api/domain/adspy-create-keyword/{INSERT-YOUR-API-KEY-HERE}",
                                    "method": "POST",
                                    "timeout": 0,
                                    "headers": {
                                      "Content-Type": "application/json"
                                    },
                                    "data": "{\"domain\":\"your-domain.com\",\"keyword\":\"is in none\",\"country\":1,\"device\":1}",
                                  };
                                  $.ajax(settings).done(function (response) {
                                    console.log(response);
                                  });
                        
                    
                        
                                require "uri"
                                require "net/http"
                                
                                url = URI("https://api.clickcease.com/api/domain/adspy-create-keyword/{INSERT-YOUR-API-KEY-HERE}")
                                
                                http = Net::HTTP.new(url.host, url.port)
                                
                                request = Net::HTTP::Post.new(url)
                                request["Content-Type"] = "application/json"
                                request.body = "{\"domain\":\"your-domain.com\",\"keyword\":\"is in none\",\"country\":1,\"device\":1}"
                                
                                response = http.request(request)
                                puts response.read_body
                        
                    
                        
                                import requests
                                url = 'https://api.clickcease.com/api/domain/adspy-create-keyword/{INSERT-YOUR-API-KEY-HERE}'
                                payload = "{\"domain\":\"your-domain.com\",\"keyword\":\"is in none\",\"country\":1,\"device\":1}"
                                headers = {
                                  'Content-Type': 'application/json'
                                }
                                response = requests.request('POST', url, headers = headers, data = payload, allow_redirects=False, timeout=undefined, allow_redirects=false)
                                print(response.text)
                        
                    
                        
                                var http = require('http');

                                var options = {
                                  'method': 'POST',
                                  'hostname': 'api.clickcease.com',
                                  'path': '/api/domain/adspy-create-keyword/{INSERT-YOUR-API-KEY-HERE}',
                                  'headers': {
                                    'Content-Type': 'application/json'
                                  }
                                };
                                
                                var req = http.request(options, function (res) {
                                  var chunks = [];
                                
                                  res.on("data", function (chunk) {
                                    chunks.push(chunk);
                                  });
                                
                                  res.on("end", function (chunk) {
                                    var body = Buffer.concat(chunks);
                                    console.log(body.toString());
                                  });
                                
                                  res.on("error", function (error) {
                                    console.error(error);
                                  });
                                });
                                
                                var postData =  "{\"domain\":\"your-domain.com\",\"keyword\":\"is in none\",\"country\":1,\"device\":1}";
                                
                                req.write(postData);
                                
                                req.end();
                        
                    
                            
                                    <?php

                                    $curl = curl_init();
                                    
                                    curl_setopt_array($curl, array(
                                      CURLOPT_URL => "https://api.clickcease.com/api/domain/adspy-create-keyword/{INSERT-YOUR-API-KEY-HERE}",
                                      CURLOPT_RETURNTRANSFER => true,
                                      CURLOPT_ENCODING => "",
                                      CURLOPT_MAXREDIRS => 10,
                                      CURLOPT_TIMEOUT => 0,
                                      CURLOPT_FOLLOWLOCATION => false,
                                      CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
                                      CURLOPT_CUSTOMREQUEST => "POST",
                                      CURLOPT_POSTFIELDS =>"{\"domain\":\"your-domain.com\",\"keyword\":\"is in none\",\"country\":1,\"device\":1}",
                                      CURLOPT_HTTPHEADER => array(
                                        "Content-Type: application/json"
                                      ),
                                    ));
                                    
                                    $response = curl_exec($curl);
                                    $err = curl_error($curl);
                                    
                                    curl_close($curl);
                                    
                                    if ($err) {
                                      echo "cURL Error #:" . $err;
                                    } else {
                                      echo $response;
                                    } ?>
                            
                    
                            
                                    package main

                                    import (
                                      "fmt"
                                      "strings"
                                      "os"
                                      "path/filepath"
                                      "net/http"
                                      "io/ioutil"
                                    )
                                    
                                    func main() {
                                    
                                      url := "https://api.clickcease.com/api/domain/adspy-create-keyword/{INSERT-YOUR-API-KEY-HERE}"
                                      method := "POST"
                                    
                                      payload := strings.NewReader("{\"domain\":\"your-domain.com\",\"keyword\":\"is in none\",\"country\":1,\"device\":1}")
                                    
                                      client := &http.Client {
                                        CheckRedirect: func(req *http.Request, via []*http.Request) error {
                                          return http.ErrUseLastResponse
                                        },
                                      }
                                      req, err := http.NewRequest(method, url, payload)
                                    
                                      if err != nil {
                                        fmt.Println(err)
                                      }
                                      req.Header.Add("Content-Type", "application/json")
                                    
                                      res, err := client.Do(req)
                                      defer res.Body.Close()
                                      body, err := ioutil.ReadAll(res.Body)
                                    
                                      fmt.Println(string(body))
                                    }
                            
                    

API Call Count

Returns the number of times an API was called

POST https://api.clickcease.com/api/client/api-call-count
Example Request
                        
                                curl --location --request POST "https://api.clickcease.com/api/client/api-call-count/{INSERT-YOUR-API-KEY-HERE}" \
                                --header "Content-Type: application/json" \
                                --data "{\"start_date\":\"2018-01-23\",\"end_date\":\"2020-01-23\"}"
                        
                    
                        
                                var settings = {
                                    "url": "https://api.clickcease.com/api/client/api-call-count/{INSERT-YOUR-API-KEY-HERE}",
                                    "method": "POST",
                                    "timeout": 0,
                                    "headers": {
                                      "Content-Type": "application/json"
                                    },
                                    "data": "{\"start_date\":\"2018-01-23\",\"end_date\":\"2020-01-23\"}",
                                  };
                                  $.ajax(settings).done(function (response) {
                                    console.log(response);
                                  });
                        
                    
                        
                                require "uri"
                                require "net/http"
                                
                                url = URI("https://api.clickcease.com/api/client/api-call-count/{INSERT-YOUR-API-KEY-HERE}")
                                
                                http = Net::HTTP.new(url.host, url.port)
                                
                                request = Net::HTTP::Post.new(url)
                                request["Content-Type"] = "application/json"
                                request.body = "{\"start_date\":\"2018-01-23\",\"end_date\":\"2020-01-23\"}"
                                
                                response = http.request(request)
                                puts response.read_body
                        
                    
                        
                                import requests
                                url = 'https://api.clickcease.com/api/client/api-call-count/{INSERT-YOUR-API-KEY-HERE}'
                                payload = "{\"start_date\":\"2018-01-23\",\"end_date\":\"2020-01-23\"}"
                                headers = {
                                  'Content-Type': 'application/json'
                                }
                                response = requests.request('POST', url, headers = headers, data = payload, allow_redirects=False, timeout=undefined, allow_redirects=false)
                                print(response.text)
                        
                    
                        
                                var http = require('http');

                                var options = {
                                  'method': 'POST',
                                  'hostname': 'api.clickcease.com',
                                  'path': '/api/client/api-call-count/{INSERT-YOUR-API-KEY-HERE}',
                                  'headers': {
                                    'Content-Type': 'application/json'
                                  }
                                };
                                
                                var req = http.request(options, function (res) {
                                  var chunks = [];
                                
                                  res.on("data", function (chunk) {
                                    chunks.push(chunk);
                                  });
                                
                                  res.on("end", function (chunk) {
                                    var body = Buffer.concat(chunks);
                                    console.log(body.toString());
                                  });
                                
                                  res.on("error", function (error) {
                                    console.error(error);
                                  });
                                });
                                
                                var postData =  "{\"start_date\":\"2018-01-23\",\"end_date\":\"2020-01-23\"}";
                                
                                req.write(postData);
                                
                                req.end();
                        
                    
                            
                                    <?php

                                    $curl = curl_init();
                                    
                                    curl_setopt_array($curl, array(
                                      CURLOPT_URL => "https://api.clickcease.com/api/client/api-call-count/{INSERT-YOUR-API-KEY-HERE}",
                                      CURLOPT_RETURNTRANSFER => true,
                                      CURLOPT_ENCODING => "",
                                      CURLOPT_MAXREDIRS => 10,
                                      CURLOPT_TIMEOUT => 0,
                                      CURLOPT_FOLLOWLOCATION => false,
                                      CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
                                      CURLOPT_CUSTOMREQUEST => "POST",
                                      CURLOPT_POSTFIELDS =>"{\"start_date\":\"2018-01-23\",\"end_date\":\"2020-01-23\"}",
                                      CURLOPT_HTTPHEADER => array(
                                        "Content-Type: application/json"
                                      ),
                                    ));
                                    
                                    $response = curl_exec($curl);
                                    $err = curl_error($curl);
                                    
                                    curl_close($curl);
                                    
                                    if ($err) {
                                      echo "cURL Error #:" . $err;
                                    } else {
                                      echo $response;
                                    } ?>
                            
                    
                            
                                    package main

                                    import (
                                      "fmt"
                                      "strings"
                                      "os"
                                      "path/filepath"
                                      "net/http"
                                      "io/ioutil"
                                    )
                                    
                                    func main() {
                                    
                                      url := "https://api.clickcease.com/api/client/api-call-count/{INSERT-YOUR-API-KEY-HERE}"
                                      method := "POST"
                                    
                                      payload := strings.NewReader("{\"start_date\":\"2018-01-23\",\"end_date\":\"2020-01-23\"}")
                                    
                                      client := &http.Client {
                                        CheckRedirect: func(req *http.Request, via []*http.Request) error {
                                          return http.ErrUseLastResponse
                                        },
                                      }
                                      req, err := http.NewRequest(method, url, payload)
                                    
                                      if err != nil {
                                        fmt.Println(err)
                                      }
                                      req.Header.Add("Content-Type", "application/json")
                                    
                                      res, err := client.Do(req)
                                      defer res.Body.Close()
                                      body, err := ioutil.ReadAll(res.Body)
                                    
                                      fmt.Println(string(body))
                                    }
                            
                    
Example Response
                        
                            { "count": 888 }
                        
                    

Create Domain

Creates a new domain

POST https://api.clickcease.com/api/client/create-domain
Example Request
                        
                                curl --location --request POST "https://api.clickcease.com/api/client/create-domain/383a0cc618f77e207386e4e6bbff11d03440a99b256bdd314e73add67f7285c3b836" \
                                --header "Content-Type: application/json" \
                                --data "{\"domain\":\"mynewtestdomain.com\"}"
                        
                    
                        
                                var settings = {
                                    "url": "https://api.clickcease.com/api/client/create-domain/383a0cc618f77e207386e4e6bbff11d03440a99b256bdd314e73add67f7285c3b836",
                                    "method": "POST",
                                    "timeout": 0,
                                    "headers": {
                                        "Content-Type": "application/json"
                                    },
                                    "data": "{\"domain\":\"mynewtestdomain.com\"}",
                                    };
                                    $.ajax(settings).done(function (response) {
                                    console.log(response);
                                    });
                        
                    
                        
                                require "uri"
                                require "net/http"
                                
                                url = URI("https://api.clickcease.com/api/client/api-call-count/{INSERT-YOUR-API-KEY-HERE}")
                                
                                http = Net::HTTP.new(url.host, url.port)
                                
                                request = Net::HTTP::Post.new(url)
                                request["Content-Type"] = "application/json"
                                request.body = "{\"start_date\":\"2018-01-23\",\"end_date\":\"2020-01-23\"}"
                                
                                response = http.request(request)
                                puts response.read_body
                        
                    
                        
                                import requests
                                url = 'https://api.clickcease.com/api/client/create-domain/383a0cc618f77e207386e4e6bbff11d03440a99b256bdd314e73add67f7285c3b836'
                                payload = "{\"domain\":\"mynewtestdomain.com\"}"
                                headers = {
                                    'Content-Type': 'application/json'
                                }
                                response = requests.request('POST', url, headers = headers, data = payload, allow_redirects=False, timeout=undefined, allow_redirects=false)
                                print(response.text)
                        
                    
                        
                                var http = require('http');

                                var options = {
                                    'method': 'POST',
                                    'hostname': 'api.clickcease.com',
                                    'path': '/api/client/create-domain/383a0cc618f77e207386e4e6bbff11d03440a99b256bdd314e73add67f7285c3b836',
                                    'headers': {
                                    'Content-Type': 'application/json'
                                    }
                                };
                                
                                var req = http.request(options, function (res) {
                                    var chunks = [];
                                
                                    res.on("data", function (chunk) {
                                    chunks.push(chunk);
                                    });
                                
                                    res.on("end", function (chunk) {
                                    var body = Buffer.concat(chunks);
                                    console.log(body.toString());
                                    });
                                
                                    res.on("error", function (error) {
                                    console.error(error);
                                    });
                                });
                                
                                var postData =  "{\"domain\":\"mynewtestdomain.com\"}";
                                
                                req.write(postData);
                                
                                req.end();
                        
                    
                            
                                    <?php

                                    $curl = curl_init();
                                    
                                    curl_setopt_array($curl, array(
                                        CURLOPT_URL => "https://api.clickcease.com/api/client/create-domain/383a0cc618f77e207386e4e6bbff11d03440a99b256bdd314e73add67f7285c3b836",
                                        CURLOPT_RETURNTRANSFER => true,
                                        CURLOPT_ENCODING => "",
                                        CURLOPT_MAXREDIRS => 10,
                                        CURLOPT_TIMEOUT => 0,
                                        CURLOPT_FOLLOWLOCATION => false,
                                        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
                                        CURLOPT_CUSTOMREQUEST => "POST",
                                        CURLOPT_POSTFIELDS =>"{\"domain\":\"mynewtestdomain.com\"}",
                                        CURLOPT_HTTPHEADER => array(
                                        "Content-Type: application/json"
                                        ),
                                    ));
                                    
                                    $response = curl_exec($curl);
                                    $err = curl_error($curl);
                                    
                                    curl_close($curl);
                                    
                                    if ($err) {
                                        echo "cURL Error #:" . $err;
                                    } else {
                                        echo $response;
                                    } ?>
                            
                    
                        
                                package main

                                import (
                                    "fmt"
                                    "strings"
                                    "os"
                                    "path/filepath"
                                    "net/http"
                                    "io/ioutil"
                                )
                                
                                func main() {
                                
                                    url := "https://api.clickcease.com/api/client/create-domain/383a0cc618f77e207386e4e6bbff11d03440a99b256bdd314e73add67f7285c3b836"
                                    method := "POST"
                                
                                    payload := strings.NewReader("{\"domain\":\"mynewtestdomain.com\"}")
                                
                                    client := &http.Client {
                                    CheckRedirect: func(req *http.Request, via []*http.Request) error {
                                        return http.ErrUseLastResponse
                                    },
                                    }
                                    req, err := http.NewRequest(method, url, payload)
                                
                                    if err != nil {
                                    fmt.Println(err)
                                    }
                                    req.Header.Add("Content-Type", "application/json")
                                
                                    res, err := client.Do(req)
                                    defer res.Body.Close()
                                    body, err := ioutil.ReadAll(res.Body)
                                
                                    fmt.Println(string(body))
                                }
                        
                
Example Response
                    
                            { "message": "Domain mynewtestdomain.com was successfully added to your account." }
                    
                

Delete Key

Deletes an API Key

POST https://api.clickcease.com/api/client/delete-key
Example Request
                        
                                curl --location --request POST "https://api.clickcease.com/api/client/delete-key/383a0cc618f77e207386e4e6bbff11d03440a99b256bdd314e73add67f7285c3b836" \
                                --header "Content-Type: application/json" \
                                --data "{\"name\":\"my key\"}"
                        
                    
                        
                                var settings = {
                                    "url": "https://api.clickcease.com/api/client/delete-key/383a0cc618f77e207386e4e6bbff11d03440a99b256bdd314e73add67f7285c3b836",
                                    "method": "POST",
                                    "timeout": 0,
                                    "headers": {
                                        "Content-Type": "application/json"
                                    },
                                    "data": "{\"name\":\"my key\"}",
                                    };
                                    $.ajax(settings).done(function (response) {
                                    console.log(response);
                                    });
                        
                    
                        
                                require "uri"
                                require "net/http"
                                
                                url = URI("https://api.clickcease.com/api/client/delete-key/383a0cc618f77e207386e4e6bbff11d03440a99b256bdd314e73add67f7285c3b836")
                                
                                http = Net::HTTP.new(url.host, url.port)
                                
                                request = Net::HTTP::Post.new(url)
                                request["Content-Type"] = "application/json"
                                request.body = "{\"name\":\"my key\"}"
                                
                                response = http.request(request)
                                puts response.read_body
                        
                    
                        
                                import requests
                                url = 'https://api.clickcease.com/api/client/delete-key/383a0cc618f77e207386e4e6bbff11d03440a99b256bdd314e73add67f7285c3b836'
                                payload = "{\"name\":\"my key\"}"
                                headers = {
                                    'Content-Type': 'application/json'
                                }
                                response = requests.request('POST', url, headers = headers, data = payload, allow_redirects=False, timeout=undefined, allow_redirects=false)
                                print(response.text)
                        
                    
                        
                                var http = require('http');

                                var options = {
                                    'method': 'POST',
                                    'hostname': 'api.clickcease.com',
                                    'path': '/api/client/delete-key/383a0cc618f77e207386e4e6bbff11d03440a99b256bdd314e73add67f7285c3b836',
                                    'headers': {
                                    'Content-Type': 'application/json'
                                    }
                                };
                                
                                var req = http.request(options, function (res) {
                                    var chunks = [];
                                
                                    res.on("data", function (chunk) {
                                    chunks.push(chunk);
                                    });
                                
                                    res.on("end", function (chunk) {
                                    var body = Buffer.concat(chunks);
                                    console.log(body.toString());
                                    });
                                
                                    res.on("error", function (error) {
                                    console.error(error);
                                    });
                                });
                                
                                var postData =  "{\"name\":\"my key\"}";
                                
                                req.write(postData);
                                
                                req.end();
                        
                    
                        
                                <?php

                                $curl = curl_init();
                                
                                curl_setopt_array($curl, array(
                                    CURLOPT_URL => "https://api.clickcease.com/api/client/delete-key/383a0cc618f77e207386e4e6bbff11d03440a99b256bdd314e73add67f7285c3b836",
                                    CURLOPT_RETURNTRANSFER => true,
                                    CURLOPT_ENCODING => "",
                                    CURLOPT_MAXREDIRS => 10,
                                    CURLOPT_TIMEOUT => 0,
                                    CURLOPT_FOLLOWLOCATION => false,
                                    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
                                    CURLOPT_CUSTOMREQUEST => "POST",
                                    CURLOPT_POSTFIELDS =>"{\"name\":\"my key\"}",
                                    CURLOPT_HTTPHEADER => array(
                                    "Content-Type: application/json"
                                    ),
                                ));
                                
                                $response = curl_exec($curl);
                                $err = curl_error($curl);
                                
                                curl_close($curl);
                                
                                if ($err) {
                                    echo "cURL Error #:" . $err;
                                } else {
                                    echo $response;
                                } ?>
                        
                
                        
                                package main

                                import (
                                    "fmt"
                                    "strings"
                                    "os"
                                    "path/filepath"
                                    "net/http"
                                    "io/ioutil"
                                )
                                
                                func main() {
                                
                                    url := "https://api.clickcease.com/api/client/delete-key/383a0cc618f77e207386e4e6bbff11d03440a99b256bdd314e73add67f7285c3b836"
                                    method := "POST"
                                
                                    payload := strings.NewReader("{\"name\":\"my key\"}")
                                
                                    client := &http.Client {
                                    CheckRedirect: func(req *http.Request, via []*http.Request) error {
                                        return http.ErrUseLastResponse
                                    },
                                    }
                                    req, err := http.NewRequest(method, url, payload)
                                
                                    if err != nil {
                                    fmt.Println(err)
                                    }
                                    req.Header.Add("Content-Type", "application/json")
                                
                                    res, err := client.Do(req)
                                    defer res.Body.Close()
                                    body, err := ioutil.ReadAll(res.Body)
                                
                                    fmt.Println(string(body))
                                }
                        
                

Get Keys

Gets a list of API Keys

POST or GET https://api.clickcease.com/api/client/get-keys
Example Request
                            
                                    curl --location --request POST "https://api.clickcease.com/api/client/get-keys/380a0cc418f77e207386e4e6bbff51d03540f31e2dc81ee44a20af33da5368bf20ba" \
                                    --header "Content-Type: application/json" \
                                    --data ""
                            
                        
                            
                                    var settings = {
                                        "url": "https://api.clickcease.com/api/client/get-keys/380a0cc418f77e207386e4e6bbff51d03540f31e2dc81ee44a20af33da5368bf20ba",
                                        "method": "POST",
                                        "timeout": 0,
                                        "headers": {
                                            "Content-Type": "application/json"
                                        },
                                        };
                                        $.ajax(settings).done(function (response) {
                                        console.log(response);
                                        });
                            
                        
                            
                                    require "uri"
                                    require "net/http"
                                    
                                    url = URI("https://api.clickcease.com/api/client/get-keys/380a0cc418f77e207386e4e6bbff51d03540f31e2dc81ee44a20af33da5368bf20ba")
                                    
                                    http = Net::HTTP.new(url.host, url.port)
                                    
                                    request = Net::HTTP::Post.new(url)
                                    request["Content-Type"] = "application/json"
                                    
                                    response = http.request(request)
                                    puts response.read_body
                            
                        
                            
                                    import requests
                                    url = 'https://api.clickcease.com/api/client/get-keys/380a0cc418f77e207386e4e6bbff51d03540f31e2dc81ee44a20af33da5368bf20ba'
                                    headers = {
                                      'Content-Type': 'application/json'
                                    }
                                    response = requests.request('POST', url, headers = headers, data = payload, allow_redirects=False, timeout=undefined, allow_redirects=false)
                                    print(response.text)
                            
                        
                            
                                    var http = require('http');

                                    var options = {
                                      'method': 'POST',
                                      'hostname': 'api.clickcease.com',
                                      'path': '/api/client/get-keys/380a0cc418f77e207386e4e6bbff51d03540f31e2dc81ee44a20af33da5368bf20ba',
                                      'headers': {
                                        'Content-Type': 'application/json'
                                      }
                                    };
                                    
                                    var req = http.request(options, function (res) {
                                      var chunks = [];
                                    
                                      res.on("data", function (chunk) {
                                        chunks.push(chunk);
                                      });
                                    
                                      res.on("end", function (chunk) {
                                        var body = Buffer.concat(chunks);
                                        console.log(body.toString());
                                      });
                                    
                                      res.on("error", function (error) {
                                        console.error(error);
                                      });
                                    });
                                    
                                    req.end();
                            
                        
                            
                                    <?php

                                    $curl = curl_init();
                                    
                                    curl_setopt_array($curl, array(
                                      CURLOPT_URL => "https://api.clickcease.com/api/client/get-keys/380a0cc418f77e207386e4e6bbff51d03540f31e2dc81ee44a20af33da5368bf20ba",
                                      CURLOPT_RETURNTRANSFER => true,
                                      CURLOPT_ENCODING => "",
                                      CURLOPT_MAXREDIRS => 10,
                                      CURLOPT_TIMEOUT => 0,
                                      CURLOPT_FOLLOWLOCATION => false,
                                      CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
                                      CURLOPT_CUSTOMREQUEST => "POST",
                                      CURLOPT_HTTPHEADER => array(
                                        "Content-Type: application/json"
                                      ),
                                    ));
                                    
                                    $response = curl_exec($curl);
                                    $err = curl_error($curl);
                                    
                                    curl_close($curl);
                                    
                                    if ($err) {
                                      echo "cURL Error #:" . $err;
                                    } else {
                                      echo $response;
                                    } ?>
                            
                        
                            
                                    package main

                                    import (
                                      "fmt"
                                      "strings"
                                      "os"
                                      "path/filepath"
                                      "net/http"
                                      "io/ioutil"
                                    )
                                    
                                    func main() {
                                    
                                      url := "https://api.clickcease.com/api/client/get-keys/380a0cc418f77e207386e4e6bbff51d03540f31e2dc81ee44a20af33da5368bf20ba"
                                      method := "POST"
                                    
                                      payload := strings.NewReader("")
                                    
                                      client := &http.Client {
                                        CheckRedirect: func(req *http.Request, via []*http.Request) error {
                                          return http.ErrUseLastResponse
                                        },
                                      }
                                      req, err := http.NewRequest(method, url, payload)
                                    
                                      if err != nil {
                                        fmt.Println(err)
                                      }
                                      req.Header.Add("Content-Type", "application/json")
                                    
                                      res, err := client.Do(req)
                                      defer res.Body.Close()
                                      body, err := ioutil.ReadAll(res.Body)
                                    
                                      fmt.Println(string(body))
                                    }
                            
                        
Example Response
                            
                                    [  
                                    {  
                                       "name":"my api key",
                                       "create_date":"2019-01-29T17:03:40.2829688"
                                    }
                                 ]