NAV

Introduction

Welcome to the JotUrl API Version i1! This is the right place to find information on how to programmatically interact with the JotUrl interface.

Authentication

Session token

Step 1: acquiring a token

Example

  {PUBLIC_KEY} = "ae7b4635320411fe"

 {PRIVATE_KEY} = "9283c835ef5e21d3"

{GMT_DATETIME} = "2018-11-30T20:04Z"

    {PASSWORD} = HMAC_SHA256({PRIVATE_KEY}, {PUBLIC_KEY} + ':' + {GMT_DATETIME}) =
               = HMAC_SHA256("9283c835ef5e21d3", "ae7b4635320411fe:2018-11-30T20:04Z") =
               = "e78a507e8e031a02c5c81a2eacb5bd6c1f846a99af7c5d0f339f006dc44384aa"

Request

https://joturl.com/a/i1/users/login?username=test@example.com&password=e78a507e8e031a02c5c81a2eacb5bd6c1f846a99af7c5d0f339f006dc44384aa

The above request returns a JSON structured like this:

{
    "status": {
        "code": 200,
        "text": "OK",
        "error": "",
        "rate": 0
    },
    "result": {
        "session_id": "93bed02bf74e191294e22da6272a18a8",
        "datetime": "2018-11-30T20:04Z"
    }
}

Session authentication needs the generation of a session token session_id that is used to sign all other request to the API endpoints.

To generate the session_id you have to make a request (GET or POST) to the API endpoint:

https://joturl.com/a/i1/users/login?username={EMAIL}&password={PASSWORD}

where {EMAIL} is the email you use to login the JotUrl dashaboard and {PASSWORD} is obtained by using an HMAC_SHA256 hash function:

{PASSWORD} = HMAC_SHA256({PRIVATE_KEY}, {PUBLIC_KEY} + ':' + {GMT_DATETIME})

{PUBLIC_KEY} and {PRIVATE_KEY} are your public and private API keys, respectively (API Keys).

Parameter {GMT_DATETIME} is the the GMT date/time in the format YYYY-MM-ddThh:mmZ where:

Parameter {GMT_DATETIME} must be generated on a device as synchronized as possible with the GMT date/time (each request requires a new {GMT_DATETIME}).

Step 2: sign API calls

Example

_sid = {session_id} =
     = "93bed02bf74e191294e22da6272a18a8"

  _h = HMAC_SHA256({PRIVATE_KEY}, {session_id} + ':' + {GMT_DATETIME}) =
     = HMAC_SHA256("9283c835ef5e21d3", "93bed02bf74e191294e22da6272a18a8:2018-11-30T20:04Z") =
     = "c9afd295a66bdfd68b2ee5a6c1031ff343d17691d56af17504127cf22d5a9d5b"

Request

https://joturl.com/a/i1/users/info?_sid=93bed02bf74e191294e22da6272a18a8&_h=c9afd295a66bdfd68b2ee5a6c1031ff343d17691d56af17504127cf22d5a9d5b

Response

{
    "status": {
        "code": 500,
        "text": "INVALID session",
        "error": "",
        "rate": 0
    },
    "result": []
}

Every request to API endpoints have to be signed with the parameters _sid and _h. Where _sid is the session token {session_id} obtained in step 1 and _h is generated with the same method used for the {PASSWORD} parameter in step 1:

_h = HMAC_SHA256({PRIVATE_KEY}, {session_id} + ':' + {GMT_DATETIME})

Parameter {GMT_DATETIME} is obtained in the same way and follows the same rules as in step 1.

The session token

The session token session_id expires approximately every 30 days, but may expire sooner due to various factors and if you call the API method users/logout.

As a best practice, we suggest you to continue to use it until you get an "INVALID session" error response from the API endpoint. In this case, you have to restart the authentication procedure from the beginning.

Examples

The examples in this section return the expected values for the HMAC_SHA256 hash, these values can be used to test the implementation of the HMAC_SHA256 hash you are using. You can find SDKs and examples here.

PHP

PHP example.

<?php

function HMAC_SHA256( $private_key, $message, $time = null ) {
    return hash_hmac(
        'sha256',
        $message . ':' . ( $time ?: gmdate( "Y-m-d\TH:i\Z", time() ) ), 
        $private_key 
    );
}

$public_key = "ae7b4635320411fe";
$private_key = "9283c835ef5e21d3";
$gmt_datetime = "2018-11-30T20:04Z";

// e78a507e8e031a02c5c81a2eacb5bd6c1f846a99af7c5d0f339f006dc44384aa
echo HMAC_SHA256( $private_key, $public_key, $gmt_datetime );

Python

Python example.

# coding: utf8
import sys
import hmac
import hashlib

try:
    def HMAC_SHA256(private_key="", message="", time=""):
        message += ":"

        if time:
            message += str(time)
        else:
            message += str(datetime.datetime.utcnow().strftime('%Y-%m-%dT%H:%MZ'))

        return hmac.new(str.encode(private_key), str.encode(message), hashlib.sha256).hexdigest()

    public_key = "ae7b4635320411fe"
    private_key = "9283c835ef5e21d3"
    gmt_datetime = "2018-11-30T20:04Z"

    # e78a507e8e031a02c5c81a2eacb5bd6c1f846a99af7c5d0f339f006dc44384aa
    print(HMAC_SHA256(private_key, public_key, gmt_datetime))

except Exception as t:
    print(t)
    sys.exit(0)
# end try

NodeJS

NodeJS example.

const crypto = require('crypto');

try {
    function gmdate() {
        var iso = (new Date()).toISOString();

        return iso.substr(0, iso.length - 8) + 'Z';
    }

    function create_sha256(key, message) {
        var hmac = crypto.createHmac('sha256', key);
        hmac.update(message);

        return hmac.digest('hex');
    }

    function HMAC_SHA256(private_key, message, time) {
        var msg = message + ":" + (time ? time : gmdate());

        return create_sha256(private_key, msg);
    }

    var public_key = "ae7b4635320411fe";
    var private_key = "9283c835ef5e21d3";
    var gmt_datetime = "2018-11-30T20:04Z";

    // e78a507e8e031a02c5c81a2eacb5bd6c1f846a99af7c5d0f339f006dc44384aa
    console.log(HMAC_SHA256(private_key, public_key, gmt_datetime));

} catch (e) {
    console.log(e.message);
}

Java

Java example.

import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.security.NoSuchAlgorithmException;
import java.security.InvalidKeyException;
import java.text.SimpleDateFormat;
import java.util.Locale;
import java.util.Date;
import java.util.TimeZone;

public class HMAC_SHA256_EXAMPLE {

  public static String gmdate() {
    String pattern = "yyy-MM-dd'T'HH:mm'Z'";
    SimpleDateFormat simpleDateFormat = new SimpleDateFormat(pattern);
    simpleDateFormat.setTimeZone(TimeZone.getTimeZone("UTC"));

    return simpleDateFormat.format(new Date());
  }

  public static String hex(byte[] bytes) {
    StringBuilder result = new StringBuilder();
    for (byte aByte: bytes) {
      result.append(String.format("%02x", aByte));
    }

    return result.toString();
  }

  public static String HMAC_SHA256(String private_key, String message, String date_time)
        throws NoSuchAlgorithmException, InvalidKeyException {
    Mac sha256_HMAC = Mac.getInstanceNumber("HmacSHA256");
    SecretKeySpec secret_key = new SecretKeySpec(private_key.getBytes(), "HmacSHA256");
    sha256_HMAC.initClient(secret_key);

    return hex(sha256_HMAC.doFinal((message + ":" + date_time).getBytes()));
  }

  public static String HMAC_SHA256(String private_key, String message)
        throws NoSuchAlgorithmException, InvalidKeyException {
    return HMAC_SHA256(private_key, message, gmdate());
  }

  public static void main(String[] args) {
    try {
      String public_key = "ae7b4635320411fe";
      String private_key = "9283c835ef5e21d3";
      String date_time = "2018-11-30T20:04Z";

      // e78a507e8e031a02c5c81a2eacb5bd6c1f846a99af7c5d0f339f006dc44384aa
      System.out.println(HMAC_SHA256(private_key, public_key, date_time));
    }
    catch(Exception e) {
      System.out.println("Error");
    }
  }
}

C#

C# example.

using System;
using System.Security.Cryptography;
using System.Text;

namespace HMAC_SHA256_EXAMPLE
{
    class Program
    {
        public static string gmdate()
        {
            return DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mmZ");
        }

        public static string hex(byte[] ba)
        {
            StringBuilder hex = new StringBuilder(ba.Length * 2);

            foreach (byte b in ba)
            {
                hex.AppendFormat("{0:x2}", b);
            }

            return hex.ToString();
        }

        private static string HMAC_SHA256(string private_key, string message, string time = "")
        {
            var hash = new HMACSHA256(Encoding.ASCII.GetBytes(private_key));

            return hex(hash.ComputeHash(Encoding.ASCII.GetBytes(message + ":" + (time ?? gmdate()))));
        }

        static void Main(string[] args)
        {
            var public_key = "ae7b4635320411fe";
            var private_key = "9283c835ef5e21d3";
            var gmt_datetime = "2018-11-30T20:04Z";

            // e78a507e8e031a02c5c81a2eacb5bd6c1f846a99af7c5d0f339f006dc44384aa
            Console.WriteLine(HMAC_SHA256(private_key, public_key, gmt_datetime));
        }
    }
}

Flutter (Dart)

Flutter (Dart) example.

import 'dart:convert';
import 'package:crypto/crypto.dart';

void main() {
  String public_key = 'ae7b4635320411fe';
  String private_key = '9283c835ef5e21d3';
  String gmt_datetime = '2018-11-30T20:04Z';

  // e78a507e8e031a02c5c81a2eacb5bd6c1f846a99af7c5d0f339f006dc44384aa
  print(HMAC_SHA256(private_key, public_key, gmt_datetime));
}

String gmdate() {
  String iso = DateTime.now().toUtc().toIso8601String();

  return iso.substring(0, 16) + 'Z';
}

String create_sha256(String key, String message) {
  var hmacSha256 = new Hmac(sha256, utf8.encode(key));
  var digest = hmacSha256.convert(utf8.encode(message));

  return digest.toString();
}

String HMAC_SHA256(String private_key, String message, [String time = '']) {
  String msg = message + ":" + (!time.isEmpty ? time : gmdate());

  return create_sha256(private_key, msg);
}

Token authentication

Token authentication (also called bearer authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens.

Step 1: acquiring a token

Request

https://joturl.com/a/i1/apis/tokens

The above request returns a JSON structured like this:

{
    "status": {
        "code": 200,
        "text": "OK",
        "error": "",
        "rate": 0
    },
    "result": {
        "read_write_token": "tok_RWxtd74zqlcv18d6qiau75kr1bwpagqbq5",
        "read_only_token": "tok_RO064cmpvzcsxc5ufg0xzx58ms3q15bn10"
    }
}

API tokens authentication needs a read-only or read/write token that is used to sign all other request to the API endpoints. API tokens do not expire and can be reset using the endpoint apis/tokens.

To get API tokens you have to make a request (GET or POST) to the endpoint:

https://joturl.com/a/i1/users/tokens

you must already be logged in using the session token.

Step 2: sign API calls

Every request to API endpoints have to be signed with the Authorization HTTP header:

Authorization: Bearer {token}

where {token} is one of the API tokens obtained in step 1.

With the read-only token you can only call endpoints with access [read].

You can find the required access of each endpoint immediately below the endpoint itself in this documentation.

Input requests

Example

https://joturl.com/a/i1/urls/shorten?long_url=https%3A%2F%2Fwww.joturl.com%2F&alias=jot

Parameters to each JotUrl API can be passed both with the GET and POST methods.

Output formats

Query

format=json

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 87
  },
  "result": {DATA}
}

Query

format=jsonp&callback=clbfunc

Response

clbfunc({
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 87
  },
  "result": {DATA}
})

Query

format=jsonp

Response

{
  "status": {
    "code": 500,
    "text": "MISSING callback",
    "error": "",
    "rate": 21
  },
  "result": []
}

Query

format=xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>87</rate>  
  </status>  
  <result>{DATA}</result>  
</response>

Query

format=txt

Response

status_code=200
status_text=OK
status_error=
status_rate=87
result={DATA}

Query

format=plain

Response

{DATA}

The JotUrl API supports Cross Origin Resource Sharing (CORS) requests from any domain.

All JotUrl APIs support five return formats: json, jsonp, xml, txt, plain. Note that the formats txt and plain may return only limited information.

The default output format is format = json that is also used when the parameter format is invalid (e.g., format = jsonp but no callback parameter is specified).

Rate limits

If the rate limits are exceeded, the call fails and returns a 403 status code, with a LIMIT EXCEEDED status text (see Output formats for details).

Typical response

{
    "status": {
        "code": <STATUS CODE>,
        "text": "<STATUS TEXT>",
        "error": "<STATUS ERROR>",
        "rate": <REQUESTS PER SECOND>
    },
    "result": <DATA>
}

If you send requests too quickly, make sure that the rate parameter in the status response is below the rate limits set for your account. The rate parameter is always expressed in requests per second. If you exceed the limits set for your account, our engine may block your requests for a time directly proportional to the speed with which you are sending the requests: the greater the gap with your rate limits, the greater the blocking time. Finally, if you do not fall within your rate limits for a long time, our engine could permanently block any further requests.

QR-Codes

A QR-Code is provided for each shorten URL. To generate it append .qrcode or .qr to the end of any shortened link. For example: http://jo.my/jotvideo.qrcode, http://jo.my/jotvideo.qr

Errors

For each request the status code is equal to the HTTP response status that can be:

codetexterrorexplanation
200OKsuccessful request
403LIMIT EXCEEDEDdetails on the error if availablerate limit exceeded
404NOT FOUNDdetails on the error if availablethe query is well-formed but there is no available response
405METHOD NOT ALLOWEDdetails on the error if availablethe endpoint is not available to the calling user
414Request-URI Too Largedetails on the error if availableGET request contains long query information, use a POST request instead
500INVALID [PARAMETER]details on the error if availableinvalid parameter [PARAMETER] in the request
INVALID METHOD [METHOD]details on the error if availableinvalid method [METHOD]
MISSING [ARGUMENT]details on the error if availablethe required argument [ARGUMENT] is missing in the request
503GENERIC ERRORdetails on the error if availablea generic error occurred and/or the service is temporarily unavailable 1

1 A GENERIC ERROR (503) is also issued in all those cases where a parameter has passed all validation checks, but for some reason our engine cannot use it to complete the request. For example, if you try to create a tracking link with the alias $alias you will see the error INVALID alias (500), since the alias $alias contains the forbidden character $, but if you try to create a tracking link with the alias alias and it is already have been used, you will see the error GENERIC ERROR (503) and the error field of the output status will be "The chosen alias is not available".

Parameters types

API endpoints require some parameters to be sent as part of the request. Most parameters are simple strings, but some endpoints require other types to be provided.

typedescriptionexample
stringsequence of alphanumeric text or other symbolshamburger
idvariable length string obtained as a result of an API call62613864764b3762725a343966673d3d
arraycomma separated list of type string, a maximum of 100 items are allowedhamburger, test
array_of_idscomma separated list of type id, a maximum of 100 items are allowed62613864764b375a343966673d3d, 86590152f1891e680, 5952b26623c9b47ad9e
integerinteger12
floatfloat with . (point) as a decimal separator12.34
booleanboolean parameter, accepted values are true, false, on, off, 1, 01
datedate in the format yyyy-mm-dd (UTC)2019-06-04
datetimedate/time in the format yyyy-mm-dd hh:mm:ss (UTC)2019-06-04 19:21:34
jsonstringified JSON object or associative array{"test":"check"}, param[test]=check
enumis a string with a value chosen from a list of allowed valuesremarketing

JotUrl SDKs

JotUrl SDKs help you develop apps, websites and plugins that relies on all the functionality of our APIs. We currently support PHP, Python, Java and NodeJS, but you can easily integrate our APIs with all development technologies.

PHP SDK

Click here to download the SDK for PHP with an example included.

PHP example

<?php

// replace [your login] with the email you use to login into JotUrl
define( 'SDK_USER_NAME', '[your login]' );
// replace [public key] with your public key: https://www.joturl.com/reserved/settings.html#tools-api
define( 'SDK_PUBLIC_API_KEY', '[public key]' );
// replace [private key] with your private key: https://www.joturl.com/reserved/settings.html#tools-api
define( 'SDK_PRIVATE_API_KEY', '[private key]' );

require_once 'sdk/JotUrlSDK.php';

try {
    // create an instance of JotUrlSDK
    $joturl = new JotUrlSDK( SDK_USER_NAME, SDK_PUBLIC_API_KEY, SDK_PRIVATE_API_KEY );

    $joturl->wrapper( function ( $sdk ) {
        // get logged user information
        $url = $sdk->buildURL( 'users/info' );
        echo "Getting user info" . PHP_EOL;
        $result = $sdk->call( $url );
        echo "====== USER INFO ======" . PHP_EOL;
        print_r( $result );
    } );

    $joturl->wrapper( function ( $sdk ) {
        // get first 5 projects
        $url = $sdk->buildURL( 'projects/list', array( "fields" => "id,name", "length" => 5 ) );
        echo "Getting first 5 projects (if available)" . PHP_EOL;
        $result = $sdk->call( $url );
        echo "====== PROJECTS ======" . PHP_EOL;
        print_r( $result );
    } );
} catch ( Throwable $t ) {
    die( $t->getMessage() );
}

Documentation

<?php

/**
 * Creates an instance of the JotUrl SDK.
 *
 * @param string $username    the username used to login into JotURL dashboard
 * @param string $public_key  public api key, you can find it on https://www.joturl.com/reserved/settings.html#tools-api
 * @param string $private_key private api key, you can find it on https://www.joturl.com/reserved/settings.html#tools-api
 */
new JotUrlSDK( $username, $public_key, $private_key );

/**
 * Automatically try to access the JotURL API, the callback is called if the access is successful.
 *
 * @param mixed $callback callback to be called on success
 *
 * @return mixed value returned by the $callback function, an exception is thrown on error
 */
function wrapper( $callback );

/**
 * Given an endpoint and parameters (optional) returns the URL to be called.
 *
 * @param string $endpoint   endpoint to be called
 * @param array  $parameters associative array [param => value]
 *
 * @return string the URL to be called
 */
function buildURL( $endpoint, $parameters = array() );

/**
 * Call and get results from the API endpoint.
 *
 * @param string $url            URL to be called
 * @param array  $postParameters [OPTIONAL] array containing post parameters
 *
 * @return bool|array associative array containing the result of the call
 */
function call( $url, $postParameters = array() );

Python SDK

Click here to download the SDK for Python 3+ with an example included.

Python example

# coding: utf8
import sys
from sdk.JotUrlSDK import JotUrlSDK

# replace [your login] with the email you use to login into JotUrl
SDK_USER_NAME = "[your login]"
# replace [public key] with your public key: https://www.joturl.com/reserved/settings.html#tools-api
SDK_PUBLIC_API_KEY = "[public key]"
# replace [private key] with your private key: https://www.joturl.com/reserved/settings.html#tools-api
SDK_PRIVATE_API_KEY = "[private key]"

try:
    # create an instance of JotUrlSDK
    joturl = JotUrlSDK(SDK_USER_NAME, SDK_PUBLIC_API_KEY, SDK_PRIVATE_API_KEY)

    def getUserInfo(sdk):
        # get logged user information
        url = sdk.buildURL("users/info")
        print("Getting user info")
        result = sdk.call(url)
        print("====== USER INFO ======")
        print(result)


    joturl.wrapper(getUserInfo)


    def getProjectsList(sdk):
        # get first 5 projects
        url = sdk.buildURL("projects/list", {"fields": "id,name", "length": 5})
        print("Getting first 5 projects (if available)")
        result = sdk.call(url)
        print("====== PROJECTS ======")
        print(result)


    joturl.wrapper(getProjectsList)


    def getProjectsListWithPOSTRequest(sdk):
        # get first 5 projects
        url = sdk.buildURL("projects/list")
        print("Getting first 5 projects (if available) with a POST request")
        result = sdk.call(url, {"fields": "id,name", "length": 5})
        print("====== PROJECTS ======")
        print(result)


    joturl.wrapper(getProjectsListWithPOSTRequest)
except Exception as t:
    print(t)
    sys.exit(0)
# end try

Documentation

""" 
Creates an instance of the JotUrl SDK.

@param username    the username used to login into JotURL dashboard
@param public_key  public api key, you can find it on https://www.joturl.com/reserved/settings.html#tools-api
@param private_key private api key, you can find it on https://www.joturl.com/reserved/settings.html#tools-api
"""
def __init__(self, username="", public_key="", private_key=""):

"""
Automatically try to access the JotURL API, the callback is called if the access is successful.

@param callback callback to be called on success

returns True on success, raises an exception on error
"""
def wrapper(self, callback=None):

"""
Given an endpoint and parameters (optional) returns the URL to be called.

@param endpoint   endpoint to be called
@param parameters associative array [param => value]

returns the URL to be called
"""
def buildURL(self, endpoint="", parameters={}):

"""
Call and get results from the API endpoint.

@param url            URL to be called
@param postParameters [OPTIONAL] array containing post parameters

returns bool|array JSON containing the result of the call, false on failure, raises an exception on error 
"""
def call(self, url="", postParameters={}):

NodeJS SDK

Click here to download the SDK for NodeJS with an example included.

NodeJS example

// replace [your login] with the email you use to login into JotUrl
const SDK_USER_NAME = '[your login]';

// replace [public key] with your public key: https://www.joturl.com/reserved/settings.html#tools-api
const SDK_PUBLIC_API_KEY = '[public key]';

// replace [private key] with your private key: https://www.joturl.com/reserved/settings.html#tools-api
const SDK_PRIVATE_API_KEY = '[private key]';

try {
    // create an instance of JotUrlSDK
    let joturl = require('./sdk/JotUrlSDK.js')(SDK_USER_NAME, SDK_PUBLIC_API_KEY, SDK_PRIVATE_API_KEY);

    // get logged user information
    console.log("Getting user info");
    joturl.call('users/info').then(result => {
        console.log(result);

        /* get first 5 projects */
        console.log("Getting first 5 projects (if available)");
        joturl.call('projects/list', {"fields": "id,name", "length": 5}).then(result => {
            console.log(result);
        }).catch(e => {
            console.log(e.message);
        });
    }).catch(e => {
        console.log(e.message);
    });
} catch (e) {
    console.log(e.message);
}

Documentation

/**
 * Creates an instance of the JotUrl SDK.
 *
 * @param _username the username used to login into JotURL dashboard
 * @param _public_key public api key, you can find it on https://www.joturl.com/reserved/settings.html#tools-api
 * @param _private_key private api key, you can find it on https://www.joturl.com/reserved/settings.html#tools-api
 * @param base_url the base URL to be use to call API endpoints, defaults to https://joturl.com/a/i1/
 *
 * @returns {JotUrlSDK}
 */
require('JotUrlSDK')(_username, _public_key, _private_key, base_url);

/**
 * Call and get results from the API endpoint.
 *
 * @param endpoint API endpoint to be called
 * @param parameters [OPTIONAL] parameters to be passed to the call
 * @param postParameters [OPTIONAL] post parameters to be passed to the call
 *
 * @returns {Promise}
 */
function call(endpoint, parameters = {}, postParameters = {});

Java SDK

Click here to download the SDK for Java with an example included.

Java example

import joturlsdk.JotUrlRunnable;
import joturlsdk.JotUrlSDK;

public class JotUrlExample {

    public static void main(String[] args) {
        try {
            JotUrlSDK sdk = new JotUrlSDK("[username]", "[public_key]", "[private_key]");

            sdk.call("users/info", new JotUrlRunnable() {
                public void run() {
                    System.out.println(this.result);
                }
            });
        } catch (Exception e) {
            System.out.println("Error: " + e.getMessage());
        }
    }
}

Documentation

/**
 * Creates an instance of the JotUrl SDK.
 *
 * @param _username the username used to login into JotURL dashboard
 * @param _public_key public api key, you can find it on https://www.joturl.com/reserved/settings.html#tools-api
 * @param _private_key private api key, you can find it on https://www.joturl.com/reserved/settings.html#tools-api
 *
 * @returns {JotUrlSDK}
 */
JotUrlSDK sdk = new JotUrlSDK(_username, _public_key, _private_key);

/**
 * Call and get results from the API endpoint.
 *
 * @param endpoint API endpoint to be called
 * @param parameters parameters to be passed to the call (null to ignore)
 * @param postParameters post parametersto be passed to the call (null to ignore)
 *
 */
JotUrlSDK.call(String endpoint, JotUrlRunnable callback, Map<String, String> parameters, Map<String, String> postParameters);
JotUrlSDK.call(String endpoint, JotUrlRunnable callback);
JotUrlSDK.callGET(String endpoint, Map<String, String> parameters, JotUrlRunnable callback);
JotUrlSDK.callPOST(String endpoint, Map<String, String> postParameters, JotUrlRunnable callback);

Flutter SDK

Click here to download the SDK for Flutter with an example included.

Dart example

import 'package:joturlsdk/joturlsdk.dart';

void main() async {
  final String username = '[username]';
  final String public_key = '[public_key]';
  final String private_key = '[private_key]';

  try {
    JotUrlSDK sdk = new JotUrlSDK(username, public_key, private_key);

    dynamic result = await sdk.call("users/info");

    print('result: ' + result.toString());
  } catch (e) {
    print("Error: " + e.toString());
  }
}

Documentation

/**
 * Creates an instance of the JotUrl SDK.
 *
 * @param _username the username used to login into JotURL dashboard
 * @param _public_key public api key, you can find it on https://www.joturl.com/reserved/settings.html#tools-api
 * @param _private_key private api key, you can find it on https://www.joturl.com/reserved/settings.html#tools-api
 * @param base_url the base URL to be use to call API endpoints, defaults to https://joturl.com/a/i1/
 *
 * @returns JotUrlSDK
 * @constructor
 */
JotUrlSDK sdk = new JotUrlSDK(_username, _public_key, _private_key);

/**
 * Call and get results from the API endpoint.
 *
 * @param endpoint API endpoint to be called
 * @param getParameters query parameters to be passed to the call (null to ignore)
 * @param postParameters post parametersto be passed to the call (null to ignore)
 *
 */
sdk.call(endpoint, {Map<String, dynamic> getParameters = null, Map<String, dynamic> postParameters = null});

API reference

/decode

access: [READ]

This method converts API error codes into a friendly text message (in the current user language).

Example 1 (json)

Request

https://joturl.com/a/i1/decode?code=10

Query parameters

code = 10

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "message": "An error occurred while deleting the QR codes of a URL"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/decode?code=10&format=xml

Query parameters

  code = 10
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <message>An error occurred while deleting the QR codes of a URL</message>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/decode?code=10&format=txt

Query parameters

  code = 10
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_message=An error occurred while deleting the QR codes of a URL

Example 4 (plain)

Request

https://joturl.com/a/i1/decode?code=10&format=plain

Query parameters

  code = 10
format = plain

Response

An error occurred while deleting the QR codes of a URL
Required parameters
parameterdescription
codeSTRINGnumeric code representing the error message
Return values
parameterdescription
langlanguage in which the message is
messagedecoded text message

/timestamp

access: [READ]

This method returns the current server timestamp (UTC) with microseconds as float.

Example 1 (json)

Request

https://joturl.com/a/i1/timestamp

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "timestamp": 1751043194.9545
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/timestamp?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <timestamp>1751043194.9545</timestamp>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/timestamp?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_timestamp=1751043194.9545

Example 4 (plain)

Request

https://joturl.com/a/i1/timestamp?format=plain

Query parameters

format = plain

Response

1751043194.9545
Return values
parameterdescription
timestampthe current Unix timestamp with microseconds

/translate

access: [READ]

This method translates an error codes into a friendly text message.

Example 1 (json)

Request

https://joturl.com/a/i1/translate?code=sample_message&lang=en

Query parameters

code = sample_message
lang = en

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "text": "This is a sample error message",
    "lang": "en"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/translate?code=sample_message&lang=en&format=xml

Query parameters

  code = sample_message
  lang = en
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <text>This is a sample error message</text>  
    <lang>en</lang>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/translate?code=sample_message&lang=en&format=txt

Query parameters

  code = sample_message
  lang = en
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_text=This is a sample error message
result_lang=en

Example 4 (plain)

Request

https://joturl.com/a/i1/translate?code=sample_message&lang=en&format=plain

Query parameters

  code = sample_message
  lang = en
format = plain

Response

This is a sample error message
en
Required parameters
parameterdescription
codeSTRINGstring code representing the error message
Optional parameters
parameterdescription
langSTRINGlanguage in which you want to translate the message
Return values
parameterdescription
langlanguage in which the message is
texttext message corresponding to code

/apis

/apis/accepted

access: [WRITE]

This method returns the actual result from an accepted (202) API endpoint.

Example 1 (json)

Request

https://joturl.com/a/i1/apis/accepted

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": []
}

Example 2 (xml)

Request

https://joturl.com/a/i1/apis/accepted?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>

  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/apis/accepted?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result=

Example 4 (plain)

Request

https://joturl.com/a/i1/apis/accepted?format=plain

Query parameters

format = plain

Response

Example 5 (json)

Request

https://joturl.com/a/i1/apis/accepted?_accepted_id=b1c3c7b6ea2d06337db8f4275a29ee5e

Query parameters

_accepted_id = b1c3c7b6ea2d06337db8f4275a29ee5e

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "_accepted_id": "b1c3c7b6ea2d06337db8f4275a29ee5e",
    "_accepted_key": "method_id",
    "_accepted_perc": 0,
    "_accepted_count": 0,
    "_accepted_total": 0,
    "_accepted_errors": 0,
    "_accepted_dt": "2025-06-27 16:52:38"
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/apis/accepted?_accepted_id=b1c3c7b6ea2d06337db8f4275a29ee5e&format=xml

Query parameters

_accepted_id = b1c3c7b6ea2d06337db8f4275a29ee5e
      format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <_accepted_id>b1c3c7b6ea2d06337db8f4275a29ee5e</_accepted_id>  
    <_accepted_key>method_id</_accepted_key>  
    <_accepted_perc>0</_accepted_perc>  
    <_accepted_count>0</_accepted_count>  
    <_accepted_total>0</_accepted_total>  
    <_accepted_errors>0</_accepted_errors>  
    <_accepted_dt>2025-06-27 16:52:38</_accepted_dt>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/apis/accepted?_accepted_id=b1c3c7b6ea2d06337db8f4275a29ee5e&format=txt

Query parameters

_accepted_id = b1c3c7b6ea2d06337db8f4275a29ee5e
      format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result__accepted_id=b1c3c7b6ea2d06337db8f4275a29ee5e
result__accepted_key=method_id
result__accepted_perc=0
result__accepted_count=0
result__accepted_total=0
result__accepted_errors=0
result__accepted_dt=2025-06-27 16:52:38

Example 8 (plain)

Request

https://joturl.com/a/i1/apis/accepted?_accepted_id=b1c3c7b6ea2d06337db8f4275a29ee5e&format=plain

Query parameters

_accepted_id = b1c3c7b6ea2d06337db8f4275a29ee5e
      format = plain

Response

b1c3c7b6ea2d06337db8f4275a29ee5e
method_id
0
0
0
0
2025-06-27 16:52:38
Optional parameters
parameterdescription
_accepted_idIDID returned by the accepted (202) API endpoint
stop_taskBOOLEAN1 to stop the background task, _accepted_id is mandatory if stop_task is 1
Return values
parameterdescription
_accepted_count[OPTIONAL] completed subtasks (e.g., the number of imported tracking links)
_accepted_dt[OPTIONAL] starting date/time of the task
_accepted_errors[OPTIONAL] total number of subtasks not completed correctly (e.g., the number of tracking links for which the import has failed)
_accepted_id[OPTIONAL] ID of the task started by the accepted (202) API endpoint
_accepted_key[OPTIONAL] key that uniquely identifies the accepted (202) API endpoint that started the task
_accepted_perc[OPTIONAL] percentage of completition of the task
_accepted_total[OPTIONAL] total number of subtasks (e.g., the total number of tracking links to be imported)
data[OPTIONAL] data returned at the end of the task from the accepted (202) API endpoint
stopped[OPTIONAL] 1 if the task has been stopped, 0 otherwise, returned only if stop_task is 1

/apis/has_access

access: [READ]

User permissions can remove access to this version of the API. This method returns 1 only if the user has access to this version of the API.

Example 1 (json)

Request

https://joturl.com/a/i1/apis/has_access

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "has_access": 0
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/apis/has_access?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <has_access>0</has_access>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/apis/has_access?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_has_access=0

Example 4 (plain)

Request

https://joturl.com/a/i1/apis/has_access?format=plain

Query parameters

format = plain

Response

0
Return values
parameterdescription
has_access1 if the user has access to this API version, 0 otherwise

/apis/keys

access: [WRITE]

This method returns the API keys associated to the logged in user.

Example 1 (json)

Request

https://joturl.com/a/i1/apis/keys

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "public": "bb1d808c03719d0ad44a01c8c70f1c29",
    "private": "b68f04d5bc103e0be258ceadecc38038"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/apis/keys?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <public>bb1d808c03719d0ad44a01c8c70f1c29</public>  
    <private>b68f04d5bc103e0be258ceadecc38038</private>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/apis/keys?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_public=bb1d808c03719d0ad44a01c8c70f1c29
result_private=b68f04d5bc103e0be258ceadecc38038

Example 4 (plain)

Request

https://joturl.com/a/i1/apis/keys?format=plain

Query parameters

format = plain

Response

bb1d808c03719d0ad44a01c8c70f1c29
b68f04d5bc103e0be258ceadecc38038

Example 5 (json)

Request

https://joturl.com/a/i1/apis/keys?password=c9gdb1c1oc&reset=1

Query parameters

password = c9gdb1c1oc
   reset = 1

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "public": "1aea25892718295e627976cd1e72d209",
    "private": "05730884907d7fc0e4850087d86ea13b"
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/apis/keys?password=c9gdb1c1oc&reset=1&format=xml

Query parameters

password = c9gdb1c1oc
   reset = 1
  format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <public>1aea25892718295e627976cd1e72d209</public>  
    <private>05730884907d7fc0e4850087d86ea13b</private>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/apis/keys?password=c9gdb1c1oc&reset=1&format=txt

Query parameters

password = c9gdb1c1oc
   reset = 1
  format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_public=1aea25892718295e627976cd1e72d209
result_private=05730884907d7fc0e4850087d86ea13b

Example 8 (plain)

Request

https://joturl.com/a/i1/apis/keys?password=c9gdb1c1oc&reset=1&format=plain

Query parameters

password = c9gdb1c1oc
   reset = 1
  format = plain

Response

1aea25892718295e627976cd1e72d209
05730884907d7fc0e4850087d86ea13b
Optional parameters
parameterdescription
passwordSTRINGcurrent account password, to be sent if reset = 1
resetBOOLEAN1 to reset API keys, if this parameter is 1 the POST method is required (because the password is sent)
Return values
parameterdescription
privatethe user private API key
publicthe user public API key

/apis/lab

/apis/lab/add

access: [WRITE]

This method adds a new LAB script.

Example 1 (json)

Request

https://joturl.com/a/i1/apis/lab/add?name=test+script&script=LogManager.log%28%27script%27%29%3B

Query parameters

  name = test script
script = LogManager.log('script');

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "name": "test script",
    "script": "LogManager.log('script');",
    "id": "36bbd59c2c84ff94cb7c0e8b77e66e32",
    "creation": "2025-06-27 16:52:38"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/apis/lab/add?name=test+script&script=LogManager.log%28%27script%27%29%3B&format=xml

Query parameters

  name = test script
script = LogManager.log('script');
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <name>test script</name>  
    <script>LogManager.log('script');</script>  
    <id>36bbd59c2c84ff94cb7c0e8b77e66e32</id>  
    <creation>2025-06-27 16:52:38</creation>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/apis/lab/add?name=test+script&script=LogManager.log%28%27script%27%29%3B&format=txt

Query parameters

  name = test script
script = LogManager.log('script');
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_name=test script
result_script=LogManager.log('script');
result_id=36bbd59c2c84ff94cb7c0e8b77e66e32
result_creation=2025-06-27 16:52:38

Example 4 (plain)

Request

https://joturl.com/a/i1/apis/lab/add?name=test+script&script=LogManager.log%28%27script%27%29%3B&format=plain

Query parameters

  name = test script
script = LogManager.log('script');
format = plain

Response

test script
LogManager.log('script');
36bbd59c2c84ff94cb7c0e8b77e66e32
2025-06-27 16:52:38
Required parameters
parameterdescription
nameSTRINGLAB script name
scriptHTMLLAB script content
Return values
parameterdescription
creationcreation date/time of the LAB script
idID of the LAB script
nameLAB script name (max length: 100000 bytes)

/apis/lab/count

access: [READ]

This method returns the number of LAB scripts.

Example 1 (json)

Request

https://joturl.com/a/i1/apis/lab/count?search=a

Query parameters

search = a

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 3
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/apis/lab/count?search=a&format=xml

Query parameters

search = a
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>3</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/apis/lab/count?search=a&format=txt

Query parameters

search = a
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=3

Example 4 (plain)

Request

https://joturl.com/a/i1/apis/lab/count?search=a&format=plain

Query parameters

search = a
format = plain

Response

3

Example 5 (json)

Request

https://joturl.com/a/i1/apis/lab/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 46
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/apis/lab/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>46</count>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/apis/lab/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=46

Example 8 (plain)

Request

https://joturl.com/a/i1/apis/lab/count?format=plain

Query parameters

format = plain

Response

46
Optional parameters
parameterdescription
searchSTRINGfilter LAB scripts by searching them
Return values
parameterdescription
counttotal number of LAB scripts, filtered by search: if passed

/apis/lab/delete

access: [WRITE]

This method deletes LAB scripts by using the parameter ids.

Example 1 (json)

Request

https://joturl.com/a/i1/apis/lab/delete?ids=7f6ffaa6bb0b408017b62254211691b5,bff030594cd09ce531297feac0327b3f

Query parameters

ids = 7f6ffaa6bb0b408017b62254211691b5,bff030594cd09ce531297feac0327b3f

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 2
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/apis/lab/delete?ids=7f6ffaa6bb0b408017b62254211691b5,bff030594cd09ce531297feac0327b3f&format=xml

Query parameters

   ids = 7f6ffaa6bb0b408017b62254211691b5,bff030594cd09ce531297feac0327b3f
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>2</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/apis/lab/delete?ids=7f6ffaa6bb0b408017b62254211691b5,bff030594cd09ce531297feac0327b3f&format=txt

Query parameters

   ids = 7f6ffaa6bb0b408017b62254211691b5,bff030594cd09ce531297feac0327b3f
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=2

Example 4 (plain)

Request

https://joturl.com/a/i1/apis/lab/delete?ids=7f6ffaa6bb0b408017b62254211691b5,bff030594cd09ce531297feac0327b3f&format=plain

Query parameters

   ids = 7f6ffaa6bb0b408017b62254211691b5,bff030594cd09ce531297feac0327b3f
format = plain

Response

2

Example 5 (json)

Request

https://joturl.com/a/i1/apis/lab/delete?ids=6abcc8f24321d1eb8c95855eab78ee95,18aaf4672792c237acf34af9f8fe3ee3,df906bde6d2bb9848a5f23b35c3cf7df

Query parameters

ids = 6abcc8f24321d1eb8c95855eab78ee95,18aaf4672792c237acf34af9f8fe3ee3,df906bde6d2bb9848a5f23b35c3cf7df

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "ids": "18aaf4672792c237acf34af9f8fe3ee3,df906bde6d2bb9848a5f23b35c3cf7df",
    "deleted": 1
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/apis/lab/delete?ids=6abcc8f24321d1eb8c95855eab78ee95,18aaf4672792c237acf34af9f8fe3ee3,df906bde6d2bb9848a5f23b35c3cf7df&format=xml

Query parameters

   ids = 6abcc8f24321d1eb8c95855eab78ee95,18aaf4672792c237acf34af9f8fe3ee3,df906bde6d2bb9848a5f23b35c3cf7df
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <ids>18aaf4672792c237acf34af9f8fe3ee3,df906bde6d2bb9848a5f23b35c3cf7df</ids>  
    <deleted>1</deleted>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/apis/lab/delete?ids=6abcc8f24321d1eb8c95855eab78ee95,18aaf4672792c237acf34af9f8fe3ee3,df906bde6d2bb9848a5f23b35c3cf7df&format=txt

Query parameters

   ids = 6abcc8f24321d1eb8c95855eab78ee95,18aaf4672792c237acf34af9f8fe3ee3,df906bde6d2bb9848a5f23b35c3cf7df
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_ids=18aaf4672792c237acf34af9f8fe3ee3,df906bde6d2bb9848a5f23b35c3cf7df
result_deleted=1

Example 8 (plain)

Request

https://joturl.com/a/i1/apis/lab/delete?ids=6abcc8f24321d1eb8c95855eab78ee95,18aaf4672792c237acf34af9f8fe3ee3,df906bde6d2bb9848a5f23b35c3cf7df&format=plain

Query parameters

   ids = 6abcc8f24321d1eb8c95855eab78ee95,18aaf4672792c237acf34af9f8fe3ee3,df906bde6d2bb9848a5f23b35c3cf7df
format = plain

Response

18aaf4672792c237acf34af9f8fe3ee3,df906bde6d2bb9848a5f23b35c3cf7df
1
Required parameters
parameterdescription
idsARRAY_OF_IDScomma-separated list of LAB script IDs to be deleted, max number of IDs in the list: 100
Return values
parameterdescription
deletednumber of deleted scripts

/apis/lab/edit

access: [WRITE]

This method edits a LAB script.

Example 1 (json)

Request

https://joturl.com/a/i1/apis/lab/edit?id=a102bc81b3dae6c5e8820c6e592a20bf&name=test+script

Query parameters

  id = a102bc81b3dae6c5e8820c6e592a20bf
name = test script

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "a102bc81b3dae6c5e8820c6e592a20bf",
    "name": "test script",
    "updated": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/apis/lab/edit?id=a102bc81b3dae6c5e8820c6e592a20bf&name=test+script&format=xml

Query parameters

    id = a102bc81b3dae6c5e8820c6e592a20bf
  name = test script
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>a102bc81b3dae6c5e8820c6e592a20bf</id>  
    <name>test script</name>  
    <updated>1</updated>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/apis/lab/edit?id=a102bc81b3dae6c5e8820c6e592a20bf&name=test+script&format=txt

Query parameters

    id = a102bc81b3dae6c5e8820c6e592a20bf
  name = test script
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=a102bc81b3dae6c5e8820c6e592a20bf
result_name=test script
result_updated=1

Example 4 (plain)

Request

https://joturl.com/a/i1/apis/lab/edit?id=a102bc81b3dae6c5e8820c6e592a20bf&name=test+script&format=plain

Query parameters

    id = a102bc81b3dae6c5e8820c6e592a20bf
  name = test script
format = plain

Response

a102bc81b3dae6c5e8820c6e592a20bf
test script
1
Required parameters
parameterdescription
idIDID of the LAB script to edit
Optional parameters
parameterdescription
nameSTRINGLAB script name
scriptHTMLcontent of the LAB script
Return values
parameterdescription
updated1 on success, 0 otherwise

/apis/lab/info

access: [READ]

This method returns info about a LAB script.

Example 1 (json)

Request

https://joturl.com/a/i1/apis/lab/info

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": [
    {
      "id": "d4687f77c87801a0d18f2d0e091c09e1",
      "name": "script name 0",
      "creation": "2025-06-27 16:57:31",
      "script": "LogManager.log('script 0');"
    },
    {
      "id": "67d07f9faac625f1557144725b9c52b3",
      "name": "script name 1",
      "creation": "2025-06-27 17:25:52",
      "script": "LogManager.log('script 1');"
    },
    {
      "id": "c71dbc7b31cd0e8c64dfbd8828c34718",
      "name": "script name 2",
      "creation": "2025-06-27 17:29:22",
      "script": "LogManager.log('script 2');"
    },
    {
      "id": "7a171344158b2d115758c04bfe756fae",
      "name": "script name 3",
      "creation": "2025-06-27 19:03:43",
      "script": "LogManager.log('script 3');"
    },
    {
      "id": "521b17b633b8605ad1f63301a1f5f1a4",
      "name": "script name 4",
      "creation": "2025-06-27 21:16:47",
      "script": "LogManager.log('script 4');"
    }
  ]
}

Example 2 (xml)

Request

https://joturl.com/a/i1/apis/lab/info?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <i0>
      <id>d4687f77c87801a0d18f2d0e091c09e1</id>  
      <name>script name 0</name>  
      <creation>2025-06-27 16:57:31</creation>  
      <script>LogManager.log('script 0');</script>  
    </i0>  
    <i1>
      <id>67d07f9faac625f1557144725b9c52b3</id>  
      <name>script name 1</name>  
      <creation>2025-06-27 17:25:52</creation>  
      <script>LogManager.log('script 1');</script>  
    </i1>  
    <i2>
      <id>c71dbc7b31cd0e8c64dfbd8828c34718</id>  
      <name>script name 2</name>  
      <creation>2025-06-27 17:29:22</creation>  
      <script>LogManager.log('script 2');</script>  
    </i2>  
    <i3>
      <id>7a171344158b2d115758c04bfe756fae</id>  
      <name>script name 3</name>  
      <creation>2025-06-27 19:03:43</creation>  
      <script>LogManager.log('script 3');</script>  
    </i3>  
    <i4>
      <id>521b17b633b8605ad1f63301a1f5f1a4</id>  
      <name>script name 4</name>  
      <creation>2025-06-27 21:16:47</creation>  
      <script>LogManager.log('script 4');</script>  
    </i4>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/apis/lab/info?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_0_id=d4687f77c87801a0d18f2d0e091c09e1
result_0_name=script name 0
result_0_creation=2025-06-27 16:57:31
result_0_script=LogManager.log('script 0');
result_1_id=67d07f9faac625f1557144725b9c52b3
result_1_name=script name 1
result_1_creation=2025-06-27 17:25:52
result_1_script=LogManager.log('script 1');
result_2_id=c71dbc7b31cd0e8c64dfbd8828c34718
result_2_name=script name 2
result_2_creation=2025-06-27 17:29:22
result_2_script=LogManager.log('script 2');
result_3_id=7a171344158b2d115758c04bfe756fae
result_3_name=script name 3
result_3_creation=2025-06-27 19:03:43
result_3_script=LogManager.log('script 3');
result_4_id=521b17b633b8605ad1f63301a1f5f1a4
result_4_name=script name 4
result_4_creation=2025-06-27 21:16:47
result_4_script=LogManager.log('script 4');

Example 4 (plain)

Request

https://joturl.com/a/i1/apis/lab/info?format=plain

Query parameters

format = plain

Response

d4687f77c87801a0d18f2d0e091c09e1
script name 0
2025-06-27 16:57:31
LogManager.log('script 0');
67d07f9faac625f1557144725b9c52b3
script name 1
2025-06-27 17:25:52
LogManager.log('script 1');
c71dbc7b31cd0e8c64dfbd8828c34718
script name 2
2025-06-27 17:29:22
LogManager.log('script 2');
7a171344158b2d115758c04bfe756fae
script name 3
2025-06-27 19:03:43
LogManager.log('script 3');
521b17b633b8605ad1f63301a1f5f1a4
script name 4
2025-06-27 21:16:47
LogManager.log('script 4');
Required parameters
parameterdescription
idIDID of the LAB script
Return values
parameterdescription
creationcreation date/time of the LAB script
idID of the LAB script
namename of the LAB script
scriptcontent of the LAB script

/apis/lab/list

access: [READ]

This method returns a list of available custom scripts for the current user.

Example 1 (json)

Request

https://joturl.com/a/i1/apis/lab/list

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": [
    {
      "id": "2d38c74dc1ffd6433f3a31b1f92906e0",
      "name": "script name 0",
      "creation": "2025-06-27 16:56:55"
    },
    {
      "id": "4fbd5af947b549588484e9ac17a6273d",
      "name": "script name 1",
      "creation": "2025-06-27 17:52:49"
    },
    {
      "id": "2d8f343eea8bcd9d640e49d67415e9db",
      "name": "script name 2",
      "creation": "2025-06-27 18:40:15"
    },
    {
      "id": "c1e4a925504bfa9a07369ab50c048910",
      "name": "script name 3",
      "creation": "2025-06-27 18:54:12"
    },
    {
      "id": "316804e4e8ae30679e78935efd7b02af",
      "name": "script name 4",
      "creation": "2025-06-27 19:01:36"
    }
  ]
}

Example 2 (xml)

Request

https://joturl.com/a/i1/apis/lab/list?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <i0>
      <id>2d38c74dc1ffd6433f3a31b1f92906e0</id>  
      <name>script name 0</name>  
      <creation>2025-06-27 16:56:55</creation>  
    </i0>  
    <i1>
      <id>4fbd5af947b549588484e9ac17a6273d</id>  
      <name>script name 1</name>  
      <creation>2025-06-27 17:52:49</creation>  
    </i1>  
    <i2>
      <id>2d8f343eea8bcd9d640e49d67415e9db</id>  
      <name>script name 2</name>  
      <creation>2025-06-27 18:40:15</creation>  
    </i2>  
    <i3>
      <id>c1e4a925504bfa9a07369ab50c048910</id>  
      <name>script name 3</name>  
      <creation>2025-06-27 18:54:12</creation>  
    </i3>  
    <i4>
      <id>316804e4e8ae30679e78935efd7b02af</id>  
      <name>script name 4</name>  
      <creation>2025-06-27 19:01:36</creation>  
    </i4>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/apis/lab/list?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_0_id=2d38c74dc1ffd6433f3a31b1f92906e0
result_0_name=script name 0
result_0_creation=2025-06-27 16:56:55
result_1_id=4fbd5af947b549588484e9ac17a6273d
result_1_name=script name 1
result_1_creation=2025-06-27 17:52:49
result_2_id=2d8f343eea8bcd9d640e49d67415e9db
result_2_name=script name 2
result_2_creation=2025-06-27 18:40:15
result_3_id=c1e4a925504bfa9a07369ab50c048910
result_3_name=script name 3
result_3_creation=2025-06-27 18:54:12
result_4_id=316804e4e8ae30679e78935efd7b02af
result_4_name=script name 4
result_4_creation=2025-06-27 19:01:36

Example 4 (plain)

Request

https://joturl.com/a/i1/apis/lab/list?format=plain

Query parameters

format = plain

Response

2d38c74dc1ffd6433f3a31b1f92906e0
script name 0
2025-06-27 16:56:55
4fbd5af947b549588484e9ac17a6273d
script name 1
2025-06-27 17:52:49
2d8f343eea8bcd9d640e49d67415e9db
script name 2
2025-06-27 18:40:15
c1e4a925504bfa9a07369ab50c048910
script name 3
2025-06-27 18:54:12
316804e4e8ae30679e78935efd7b02af
script name 4
2025-06-27 19:01:36
Optional parameters
parameterdescription
searchSTRINGfilters items to be extracted by searching them
Return values
parameterdescription
counttotal number of LAB scripts
datalist of available/filtered LAB scripts for the current user

/apis/limits

access: [READ]

This method returns the API limits for the logged user.

Example 1 (json)

Request

https://joturl.com/a/i1/apis/limits

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "primary": {
      "limit": 500,
      "unit": "HOUR"
    },
    "secondary": {
      "limit": 50000,
      "unit": "DAY"
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/apis/limits?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <primary>
      <limit>500</limit>  
      <unit>HOUR</unit>  
    </primary>  
    <secondary>
      <limit>50000</limit>  
      <unit>DAY</unit>  
    </secondary>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/apis/limits?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_primary_limit=500
result_primary_unit=HOUR
result_secondary_limit=50000
result_secondary_unit=DAY

Example 4 (plain)

Request

https://joturl.com/a/i1/apis/limits?format=plain

Query parameters

format = plain

Response

500
HOUR
50000
DAY
Return values
parameterdescription
primaryobject containing the primary rate limit: an integer limit and the unit in which the limit is expressed. unit is one of the following [MINUTE,HOUR,DAY,3_DAY]. 3_DAY is equivalent to 3 days
secondaryobject containing the secondary rate limit: an integer limit and the unit in which the limit is expressed. unit is one of the following [MINUTE,HOUR,DAY,3_DAY]. 3_DAY is equivalent to 3 days

/apis/list

access: [READ]

This method returns the list of available versions of the API.

Example 1 (json)

Request

https://joturl.com/a/i1/apis/list

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 2,
    "data": [
      {
        "id": "v1",
        "name": "Version v1"
      },
      {
        "id": "i1",
        "name": "Version i1"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/apis/list?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>2</count>  
    <data>
      <i0>
        <id>v1</id>  
        <name>Version v1</name>  
      </i0>  
      <i1>
        <id>i1</id>  
        <name>Version i1</name>  
      </i1>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/apis/list?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=2
result_data_0_id=v1
result_data_0_name=Version v1
result_data_1_id=i1
result_data_1_name=Version i1

Example 4 (plain)

Request

https://joturl.com/a/i1/apis/list?format=plain

Query parameters

format = plain

Response

2
v1
Version v1
i1
Version i1
Optional parameters
parameterdescription
lengthINTEGERextracts this number of items (maxmimum allowed: 100)
orderbyARRAYorders items by field
searchSTRINGfilters items to be extracted by searching them
sortSTRINGsorts items in ascending (ASC) or descending (DESC) order
startINTEGERstarts to extract items from this position
Return values
parameterdescription
counttotal number of versions
dataarray containing required information on API versions the user has access to

/apis/tokens

access: [WRITE]

This method returns the API tokens associated to the logged in user.

Example 1 (json)

Request

https://joturl.com/a/i1/apis/tokens

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "read_write_token": "tok_RWfeaa3448ea7bf426f204b7ef1cc1796d",
    "read_only_token": "tok_ROa2c96a9eaa6b00e4b72952ea767bfa29"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/apis/tokens?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <read_write_token>tok_RWfeaa3448ea7bf426f204b7ef1cc1796d</read_write_token>  
    <read_only_token>tok_ROa2c96a9eaa6b00e4b72952ea767bfa29</read_only_token>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/apis/tokens?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_read_write_token=tok_RWfeaa3448ea7bf426f204b7ef1cc1796d
result_read_only_token=tok_ROa2c96a9eaa6b00e4b72952ea767bfa29

Example 4 (plain)

Request

https://joturl.com/a/i1/apis/tokens?format=plain

Query parameters

format = plain

Response

tok_RWfeaa3448ea7bf426f204b7ef1cc1796d
tok_ROa2c96a9eaa6b00e4b72952ea767bfa29

Example 5 (json)

Request

https://joturl.com/a/i1/apis/tokens?password=chkc31c9ie&reset=1

Query parameters

password = chkc31c9ie
   reset = 1

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "read_write_token": "tok_RW87081b44c5d49b8e9c037c41d14992de",
    "read_only_token": "tok_RO25e2827d801c875fc54c50905eafb6ff"
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/apis/tokens?password=chkc31c9ie&reset=1&format=xml

Query parameters

password = chkc31c9ie
   reset = 1
  format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <read_write_token>tok_RW87081b44c5d49b8e9c037c41d14992de</read_write_token>  
    <read_only_token>tok_RO25e2827d801c875fc54c50905eafb6ff</read_only_token>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/apis/tokens?password=chkc31c9ie&reset=1&format=txt

Query parameters

password = chkc31c9ie
   reset = 1
  format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_read_write_token=tok_RW87081b44c5d49b8e9c037c41d14992de
result_read_only_token=tok_RO25e2827d801c875fc54c50905eafb6ff

Example 8 (plain)

Request

https://joturl.com/a/i1/apis/tokens?password=chkc31c9ie&reset=1&format=plain

Query parameters

password = chkc31c9ie
   reset = 1
  format = plain

Response

tok_RW87081b44c5d49b8e9c037c41d14992de
tok_RO25e2827d801c875fc54c50905eafb6ff
Optional parameters
parameterdescription
passwordSTRINGcurrent account password, to be sent if reset = 1
resetBOOLEAN1 to reset the API tokens, if this parameter is 1 the POST method is required (because the password is sent)
Return values
parameterdescription
read_only_tokenthe read-only API access token
read_write_tokenthe read/write API access token

/cdns

/cdns/add

access: [WRITE]

This method allows to upload a resource to the CDN.

Example 1 (json)

Request

https://joturl.com/a/i1/cdns/add?type=image&info=%7B%22name%22%3A%22this+is+my+resource%22%7D

Query parameters

type = image
info = {"name":"this is my resource"}

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "670fa0a0dea2d9dc5ec346220bd580c3",
    "name": "this is my resource",
    "creation": "2025-06-27 16:52:38",
    "url": "https:\/\/cdn.endpoint\/path\/to\/resource",
    "width": 533,
    "height": 400,
    "size": 20903,
    "mime_type": "image\/png"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/cdns/add?type=image&info=%7B%22name%22%3A%22this+is+my+resource%22%7D&format=xml

Query parameters

  type = image
  info = {"name":"this is my resource"}
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>670fa0a0dea2d9dc5ec346220bd580c3</id>  
    <name>this is my resource</name>  
    <creation>2025-06-27 16:52:38</creation>  
    <url>https://cdn.endpoint/path/to/resource</url>  
    <width>533</width>  
    <height>400</height>  
    <size>20903</size>  
    <mime_type>image/png</mime_type>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/cdns/add?type=image&info=%7B%22name%22%3A%22this+is+my+resource%22%7D&format=txt

Query parameters

  type = image
  info = {"name":"this is my resource"}
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=670fa0a0dea2d9dc5ec346220bd580c3
result_name=this is my resource
result_creation=2025-06-27 16:52:38
result_url=https://cdn.endpoint/path/to/resource
result_width=533
result_height=400
result_size=20903
result_mime_type=image/png

Example 4 (plain)

Request

https://joturl.com/a/i1/cdns/add?type=image&info=%7B%22name%22%3A%22this+is+my+resource%22%7D&format=plain

Query parameters

  type = image
  info = {"name":"this is my resource"}
format = plain

Response

670fa0a0dea2d9dc5ec346220bd580c3
this is my resource
2025-06-27 16:52:38
https://cdn.endpoint/path/to/resource
533
400
20903
image/png
Required parameters
parameterdescription
typeSTRINGCDN type, see i1/cdns/property for details
Optional parameters
parameterdescriptionmax length
external_urlURLURL to an external resource (not managed by the CDN), this URL must be with HTTPS4000
infoJSONJSON containing additional info on the resource
inputSTRINGname of the HTML form field that contains data for the resource, if not passed the default value input will be used (i.e., input = input)

NOTES: The parameter input contains the name of the field of the HTML form that is used to send resource data to this method. Form must have enctype = "multipart/form-data" and method = "post".

<form 
    action="/a/i1/cdns/add" 
    method="post" 
    enctype="multipart/form-data">

    <input name="input" value="resource_field" type="hidden"/>

    [other form fields]

    <input name="resource_field" type="file"/>    

</form>
Return values
parameterdescription
creationdate/time when the CDN resource was created
heightheight in pixels of the CDN resource, if available
idID of the CDN resource
mime_typeMIME type of the resource, or 'external_url' for external URLs
namename of the CDN resource
sizesize in bytes of the CDN resource, if available
urlURL of the CDN resource
widthwidth in pixels of the CDN resource, if available

/cdns/count

access: [READ]

This method returns the number of resources on the CDN.

Example 1 (json)

Request

https://joturl.com/a/i1/cdns/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 4
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/cdns/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>4</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/cdns/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=4

Example 4 (plain)

Request

https://joturl.com/a/i1/cdns/count?format=plain

Query parameters

format = plain

Response

4
Required parameters
parameterdescription
typeSTRINGCDN resource type, for available types see i1/cdns/list
Optional parameters
parameterdescription
filtersJSONfilters to be used to count media, for available filters see i1/cdns/list
searchSTRINGfilters CDN resources to be extracted by searching them
Return values
parameterdescription
countnumber of (filtered) CDN resources

/cdns/delete

access: [WRITE]

This method deletes a resource from the CDN.

Example 1 (json)

Request

https://joturl.com/a/i1/cdns/delete?id=4f76ee80481c853b8c35046a99999516

Query parameters

id = 4f76ee80481c853b8c35046a99999516

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "4f76ee80481c853b8c35046a99999516",
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/cdns/delete?id=4f76ee80481c853b8c35046a99999516&format=xml

Query parameters

    id = 4f76ee80481c853b8c35046a99999516
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>4f76ee80481c853b8c35046a99999516</id>  
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/cdns/delete?id=4f76ee80481c853b8c35046a99999516&format=txt

Query parameters

    id = 4f76ee80481c853b8c35046a99999516
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=4f76ee80481c853b8c35046a99999516
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/cdns/delete?id=4f76ee80481c853b8c35046a99999516&format=plain

Query parameters

    id = 4f76ee80481c853b8c35046a99999516
format = plain

Response

4f76ee80481c853b8c35046a99999516
1
Required parameters
parameterdescription
idIDID of the CDN resource to delete
Optional parameters
parameterdescription
confirmBOOLEANIf 1 this method deletes the CDN resource even if it is linked to a tracking link
Return values
parameterdescription
deleted1 if successful, otherwise a generic error message is issued
idecho back of the id input parameter

/cdns/edit

access: [WRITE]

This method allows to modify a CDN resource.

Example 1 (json)

Request

https://joturl.com/a/i1/cdns/edit?type=image&info=%7B%22name%22%3A%22this+is+my+resource%22%7D&id=76636d1ea5627bebc603138ff4542506

Query parameters

type = image
info = {"name":"this is my resource"}
  id = 76636d1ea5627bebc603138ff4542506

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "76636d1ea5627bebc603138ff4542506",
    "name": "this is my resource",
    "creation": "2025-06-27 16:52:38",
    "url": "https:\/\/cdn.endpoint\/path\/to\/resource",
    "width": 533,
    "height": 400,
    "size": 20903,
    "mime_type": "image\/png"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/cdns/edit?type=image&info=%7B%22name%22%3A%22this+is+my+resource%22%7D&id=76636d1ea5627bebc603138ff4542506&format=xml

Query parameters

  type = image
  info = {"name":"this is my resource"}
    id = 76636d1ea5627bebc603138ff4542506
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>76636d1ea5627bebc603138ff4542506</id>  
    <name>this is my resource</name>  
    <creation>2025-06-27 16:52:38</creation>  
    <url>https://cdn.endpoint/path/to/resource</url>  
    <width>533</width>  
    <height>400</height>  
    <size>20903</size>  
    <mime_type>image/png</mime_type>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/cdns/edit?type=image&info=%7B%22name%22%3A%22this+is+my+resource%22%7D&id=76636d1ea5627bebc603138ff4542506&format=txt

Query parameters

  type = image
  info = {"name":"this is my resource"}
    id = 76636d1ea5627bebc603138ff4542506
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=76636d1ea5627bebc603138ff4542506
result_name=this is my resource
result_creation=2025-06-27 16:52:38
result_url=https://cdn.endpoint/path/to/resource
result_width=533
result_height=400
result_size=20903
result_mime_type=image/png

Example 4 (plain)

Request

https://joturl.com/a/i1/cdns/edit?type=image&info=%7B%22name%22%3A%22this+is+my+resource%22%7D&id=76636d1ea5627bebc603138ff4542506&format=plain

Query parameters

  type = image
  info = {"name":"this is my resource"}
    id = 76636d1ea5627bebc603138ff4542506
format = plain

Response

76636d1ea5627bebc603138ff4542506
this is my resource
2025-06-27 16:52:38
https://cdn.endpoint/path/to/resource
533
400
20903
image/png
Required parameters
parameterdescription
idIDID of the CDN resource
typeSTRINGCDN type, see i1/cdns/property for details
Optional parameters
parameterdescriptionmax length
external_urlURLURL to an external resource (not managed by the CDN), this URL must be with HTTPS4000
infoJSONJSON containing additional info on the resource
inputSTRINGname of the HTML form field that contains data for the resource, if not passed the default value input will be used (i.e., input = input)

NOTES: The parameter input contains the name of the field of the HTML form that is used to send resource data to this method. Form must have enctype = "multipart/form-data" and method = "post".

<form 
    action="/a/i1/cdns/edit" 
    method="post" 
    enctype="multipart/form-data">

    <input name="input" value="resource_field" type="hidden"/>

    [other form fields]

    <input name="resource_field" type="file"/>    

</form>
Return values
parameterdescription
creationdate/time when the CDN resource was created
heightheight in pixels of the CDN resource, if available
idID of the CDN resource
mime_typeMIME type of the resource, or 'external_url' for external URLs
namename of the CDN resource
sizesize in bytes of the CDN resource, if available
urlURL of the CDN resource
widthwidth in pixels of the CDN resource, if available

/cdns/info

access: [READ]

This method returns information about a resource on the CDN.

Example 1 (json)

Request

https://joturl.com/a/i1/cdns/info?id=492660bdc58d0e0f9ede65ce3282eda8

Query parameters

id = 492660bdc58d0e0f9ede65ce3282eda8

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": {
      "id": "492660bdc58d0e0f9ede65ce3282eda8",
      "name": "this is my resource",
      "creation": "2019-06-25 13:01:23",
      "url": "https:\/\/cdn.endpoint\/path\/to\/resource",
      "width": 533,
      "height": 400,
      "size": 20903,
      "mime_type": "image\/png"
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/cdns/info?id=492660bdc58d0e0f9ede65ce3282eda8&format=xml

Query parameters

    id = 492660bdc58d0e0f9ede65ce3282eda8
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <id>492660bdc58d0e0f9ede65ce3282eda8</id>  
      <name>this is my resource</name>  
      <creation>2019-06-25 13:01:23</creation>  
      <url>https://cdn.endpoint/path/to/resource</url>  
      <width>533</width>  
      <height>400</height>  
      <size>20903</size>  
      <mime_type>image/png</mime_type>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/cdns/info?id=492660bdc58d0e0f9ede65ce3282eda8&format=txt

Query parameters

    id = 492660bdc58d0e0f9ede65ce3282eda8
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_id=492660bdc58d0e0f9ede65ce3282eda8
result_data_name=this is my resource
result_data_creation=2019-06-25 13:01:23
result_data_url=https://cdn.endpoint/path/to/resource
result_data_width=533
result_data_height=400
result_data_size=20903
result_data_mime_type=image/png

Example 4 (plain)

Request

https://joturl.com/a/i1/cdns/info?id=492660bdc58d0e0f9ede65ce3282eda8&format=plain

Query parameters

    id = 492660bdc58d0e0f9ede65ce3282eda8
format = plain

Response

492660bdc58d0e0f9ede65ce3282eda8
this is my resource
2019-06-25 13:01:23
https://cdn.endpoint/path/to/resource
533
400
20903
image/png
Required parameters
parameterdescription
idIDID of the CDN resource
Return values
parameterdescription
dataarray containing required information on CDN resources

access: [WRITE]

This method allows to add an association between a CDN resource and a key and/or a tracking link. This method allows multiple instances for the combination (CDN resource,key).

Example 1 (json)

Request

https://joturl.com/a/i1/cdns/links/add?key=my_custom_config_key&cdn_id=5ae9d1b474b148f0c49854d8c1849663&value=%7B%22position%22%3A%22top_left%22%7D

Query parameters

   key = my_custom_config_key
cdn_id = 5ae9d1b474b148f0c49854d8c1849663
 value = {"position":"top_left"}

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "added": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/cdns/links/add?key=my_custom_config_key&cdn_id=5ae9d1b474b148f0c49854d8c1849663&value=%7B%22position%22%3A%22top_left%22%7D&format=xml

Query parameters

   key = my_custom_config_key
cdn_id = 5ae9d1b474b148f0c49854d8c1849663
 value = {"position":"top_left"}
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <added>1</added>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/cdns/links/add?key=my_custom_config_key&cdn_id=5ae9d1b474b148f0c49854d8c1849663&value=%7B%22position%22%3A%22top_left%22%7D&format=txt

Query parameters

   key = my_custom_config_key
cdn_id = 5ae9d1b474b148f0c49854d8c1849663
 value = {"position":"top_left"}
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_added=1

Example 4 (plain)

Request

https://joturl.com/a/i1/cdns/links/add?key=my_custom_config_key&cdn_id=5ae9d1b474b148f0c49854d8c1849663&value=%7B%22position%22%3A%22top_left%22%7D&format=plain

Query parameters

   key = my_custom_config_key
cdn_id = 5ae9d1b474b148f0c49854d8c1849663
 value = {"position":"top_left"}
format = plain

Response

1
Required parameters
parameterdescriptionmax length
cdn_idIDID of the CDN resource
keySTRINGkey that identifies the CDN resource/tracking link association, available values: reports_config, instaurl, instaurl_bg, instaurl_images, preview_image50
Optional parameters
parameterdescription
url_idIDID of the tracking link
valueJSONvalue for the association, it must be a stringified JSON
Return values
parameterdescription
added1 on success, 0 otherwise

access: [WRITE]

This method deletes all the associations between a CDN resource and a key and/or a tracking link. If the resource ID is not passed, it deletes all associations by using the key.

Example 1 (json)

Request

https://joturl.com/a/i1/cdns/links/delete?key=my_custom_config_key&cdn_id=cd8ec3d4b75e1c432dda0b9b4731dac8

Query parameters

   key = my_custom_config_key
cdn_id = cd8ec3d4b75e1c432dda0b9b4731dac8

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 10
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/cdns/links/delete?key=my_custom_config_key&cdn_id=cd8ec3d4b75e1c432dda0b9b4731dac8&format=xml

Query parameters

   key = my_custom_config_key
cdn_id = cd8ec3d4b75e1c432dda0b9b4731dac8
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>10</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/cdns/links/delete?key=my_custom_config_key&cdn_id=cd8ec3d4b75e1c432dda0b9b4731dac8&format=txt

Query parameters

   key = my_custom_config_key
cdn_id = cd8ec3d4b75e1c432dda0b9b4731dac8
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=10

Example 4 (plain)

Request

https://joturl.com/a/i1/cdns/links/delete?key=my_custom_config_key&cdn_id=cd8ec3d4b75e1c432dda0b9b4731dac8&format=plain

Query parameters

   key = my_custom_config_key
cdn_id = cd8ec3d4b75e1c432dda0b9b4731dac8
format = plain

Response

10
Required parameters
parameterdescriptionmax length
keySTRINGkey that identifies the CDN resource/tracking link association, available values: reports_config, instaurl, instaurl_bg, instaurl_images, preview_image50
Optional parameters
parameterdescription
cdn_idIDif passed, only the associations with the CDN resource identified by this ID will be deleted
url_idIDif passed, only the associations with the tracking link identified by this ID will be deleted
Return values
parameterdescription
deletednumber of deleted associations

access: [READ]

This method returns all the associations between a CDN resource and a key and/or a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/cdns/links/get?key=my_custom_config_key&cdn_id=388be66128cb44abba2f80a74d8b95e9

Query parameters

   key = my_custom_config_key
cdn_id = 388be66128cb44abba2f80a74d8b95e9

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": {
      "id": "9684935e3a02e1d57fe5671d163c8af4",
      "key": "my_custom_config_key",
      "value": {
        "position": "top_left"
      },
      "cdn_id": "388be66128cb44abba2f80a74d8b95e9",
      "url_id": "aa501fad24289dac708e0101df0ab13b",
      "name": "this is my resource",
      "creation": "2019-06-25 13:01:23",
      "url": "https:\/\/cdn.endpoint\/path\/to\/resource",
      "width": 533,
      "height": 400,
      "size": 20903,
      "mime_type": "image\/png"
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/cdns/links/get?key=my_custom_config_key&cdn_id=388be66128cb44abba2f80a74d8b95e9&format=xml

Query parameters

   key = my_custom_config_key
cdn_id = 388be66128cb44abba2f80a74d8b95e9
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <id>9684935e3a02e1d57fe5671d163c8af4</id>  
      <key>my_custom_config_key</key>  
      <value>
        <position>top_left</position>  
      </value>  
      <cdn_id>388be66128cb44abba2f80a74d8b95e9</cdn_id>  
      <url_id>aa501fad24289dac708e0101df0ab13b</url_id>  
      <name>this is my resource</name>  
      <creation>2019-06-25 13:01:23</creation>  
      <url>https://cdn.endpoint/path/to/resource</url>  
      <width>533</width>  
      <height>400</height>  
      <size>20903</size>  
      <mime_type>image/png</mime_type>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/cdns/links/get?key=my_custom_config_key&cdn_id=388be66128cb44abba2f80a74d8b95e9&format=txt

Query parameters

   key = my_custom_config_key
cdn_id = 388be66128cb44abba2f80a74d8b95e9
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_id=9684935e3a02e1d57fe5671d163c8af4
result_data_key=my_custom_config_key
result_data_value_position=top_left
result_data_cdn_id=388be66128cb44abba2f80a74d8b95e9
result_data_url_id=aa501fad24289dac708e0101df0ab13b
result_data_name=this is my resource
result_data_creation=2019-06-25 13:01:23
result_data_url=https://cdn.endpoint/path/to/resource
result_data_width=533
result_data_height=400
result_data_size=20903
result_data_mime_type=image/png

Example 4 (plain)

Request

https://joturl.com/a/i1/cdns/links/get?key=my_custom_config_key&cdn_id=388be66128cb44abba2f80a74d8b95e9&format=plain

Query parameters

   key = my_custom_config_key
cdn_id = 388be66128cb44abba2f80a74d8b95e9
format = plain

Response

9684935e3a02e1d57fe5671d163c8af4
my_custom_config_key
top_left
388be66128cb44abba2f80a74d8b95e9
aa501fad24289dac708e0101df0ab13b
this is my resource
2019-06-25 13:01:23
https://cdn.endpoint/path/to/resource
533
400
20903
image/png
Required parameters
parameterdescriptionmax length
keySTRINGkey that identifies the CDN resource/tracking link association, available values: reports_config, instaurl, instaurl_bg, instaurl_images, preview_image50
Optional parameters
parameterdescription
cdn_idIDif passed, only the associations with the CDN resource identified by this ID will be returned
url_idIDif passed, only the associations with the tracking link identified by this ID will be returned
Return values
parameterdescription
dataarray containing information on the association and the linked CDN resource

access: [WRITE]

This method allows to set the association between a CDN resource and a key and/or a tracking link. This method allows only one instance for the combination (CDN resource,key).

Example 1 (json)

Request

https://joturl.com/a/i1/cdns/links/set?key=my_custom_config_key&cdn_id=a34f4e549b8527be54861f4f43187d0a&value=%7B%22position%22%3A%22top_left%22%7D

Query parameters

   key = my_custom_config_key
cdn_id = a34f4e549b8527be54861f4f43187d0a
 value = {"position":"top_left"}

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "set": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/cdns/links/set?key=my_custom_config_key&cdn_id=a34f4e549b8527be54861f4f43187d0a&value=%7B%22position%22%3A%22top_left%22%7D&format=xml

Query parameters

   key = my_custom_config_key
cdn_id = a34f4e549b8527be54861f4f43187d0a
 value = {"position":"top_left"}
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <set>1</set>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/cdns/links/set?key=my_custom_config_key&cdn_id=a34f4e549b8527be54861f4f43187d0a&value=%7B%22position%22%3A%22top_left%22%7D&format=txt

Query parameters

   key = my_custom_config_key
cdn_id = a34f4e549b8527be54861f4f43187d0a
 value = {"position":"top_left"}
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_set=1

Example 4 (plain)

Request

https://joturl.com/a/i1/cdns/links/set?key=my_custom_config_key&cdn_id=a34f4e549b8527be54861f4f43187d0a&value=%7B%22position%22%3A%22top_left%22%7D&format=plain

Query parameters

   key = my_custom_config_key
cdn_id = a34f4e549b8527be54861f4f43187d0a
 value = {"position":"top_left"}
format = plain

Response

1
Required parameters
parameterdescriptionmax length
cdn_idIDID of the CDN resource
keySTRINGkey that identifies the CDN resource/tracking link association, available values: reports_config, instaurl, instaurl_bg, instaurl_images, preview_image50
Optional parameters
parameterdescription
url_idIDID of the tracking link
valueJSONvalue for the association, it must be a stringified JSON
Return values
parameterdescription
set1 on success, 0 otherwise

/cdns/list

access: [READ]

This method returns a list of resource on the CDN linked with the current user.

Example 1 (json)

Request

https://joturl.com/a/i1/cdns/list?type=image

Query parameters

type = image

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 1,
    "data": {
      "id": "1234567890abcdef",
      "name": "this is my resource",
      "creation": "2019-06-25 13:01:23",
      "url": "https:\/\/cdn.endpoint\/path\/to\/resource",
      "width": 533,
      "height": 400,
      "size": 20903,
      "mime_type": "image\/png"
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/cdns/list?type=image&format=xml

Query parameters

  type = image
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>1</count>  
    <data>
      <id>1234567890abcdef</id>  
      <name>this is my resource</name>  
      <creation>2019-06-25 13:01:23</creation>  
      <url>https://cdn.endpoint/path/to/resource</url>  
      <width>533</width>  
      <height>400</height>  
      <size>20903</size>  
      <mime_type>image/png</mime_type>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/cdns/list?type=image&format=txt

Query parameters

  type = image
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=1
result_data_id=1234567890abcdef
result_data_name=this is my resource
result_data_creation=2019-06-25 13:01:23
result_data_url=https://cdn.endpoint/path/to/resource
result_data_width=533
result_data_height=400
result_data_size=20903
result_data_mime_type=image/png

Example 4 (plain)

Request

https://joturl.com/a/i1/cdns/list?type=image&format=plain

Query parameters

  type = image
format = plain

Response

1
1234567890abcdef
this is my resource
2019-06-25 13:01:23
https://cdn.endpoint/path/to/resource
533
400
20903
image/png
Required parameters
parameterdescription
typeSTRINGCDN type, see i1/cdns/property for details
Optional parameters
parameterdescription
filtersJSONfilters to be used extracing media
lengthINTEGERextracts this number of CDN resources (maxmimum allowed: 100)
searchSTRINGfilters CDN resources to be extracted by searching them
startINTEGERstarts to extract CDN resources from this position
Return values
parameterdescription
counttotal number of (filtered) CDN resources
dataarray containing required information on CDN resources

/cdns/property

access: [READ]

This method return limits for uploading a resource on the CDN.

Example 1 (json)

Request

https://joturl.com/a/i1/cdns/property

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "image": {
      "max_size": 5242880,
      "allowed_types": [
        "gif",
        "jpg",
        "png",
        "svg",
        "webp"
      ],
      "allowed_mimes": [
        "image\/gif",
        "image\/jpeg",
        "image\/jpg",
        "image\/pjpeg",
        "image\/x-png",
        "image\/png",
        "image\/svg+xml",
        "application\/svg+xml",
        "image\/webp"
      ]
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/cdns/property?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <image>
      <max_size>5242880</max_size>  
      <allowed_types>
        <i0>gif</i0>  
        <i1>jpg</i1>  
        <i2>png</i2>  
        <i3>svg</i3>  
        <i4>webp</i4>  
      </allowed_types>  
      <allowed_mimes>
        <i0>image/gif</i0>  
        <i1>image/jpeg</i1>  
        <i2>image/jpg</i2>  
        <i3>image/pjpeg</i3>  
        <i4>image/x-png</i4>  
        <i5>image/png</i5>  
        <i6>image/svg+xml</i6>  
        <i7>application/svg+xml</i7>  
        <i8>image/webp</i8>  
      </allowed_mimes>  
    </image>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/cdns/property?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_image_max_size=5242880
result_image_allowed_types_0=gif
result_image_allowed_types_1=jpg
result_image_allowed_types_2=png
result_image_allowed_types_3=svg
result_image_allowed_types_4=webp
result_image_allowed_mimes_0=image/gif
result_image_allowed_mimes_1=image/jpeg
result_image_allowed_mimes_2=image/jpg
result_image_allowed_mimes_3=image/pjpeg
result_image_allowed_mimes_4=image/x-png
result_image_allowed_mimes_5=image/png
result_image_allowed_mimes_6=image/svg+xml
result_image_allowed_mimes_7=application/svg+xml
result_image_allowed_mimes_8=image/webp

Example 4 (plain)

Request

https://joturl.com/a/i1/cdns/property?format=plain

Query parameters

format = plain

Response

5242880
gif
jpg
png
svg
webp
image/gif
image/jpeg
image/jpg
image/pjpeg
image/x-png
image/png
image/svg+xml
application/svg+xml
image/webp

Example 5 (json)

Request

https://joturl.com/a/i1/cdns/property?type=image

Query parameters

type = image

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "max_size": 5242880,
    "allowed_types": [
      "gif",
      "jpg",
      "png",
      "svg",
      "webp"
    ],
    "allowed_mimes": [
      "image\/gif",
      "image\/jpeg",
      "image\/jpg",
      "image\/pjpeg",
      "image\/x-png",
      "image\/png",
      "image\/svg+xml",
      "application\/svg+xml",
      "image\/webp"
    ]
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/cdns/property?type=image&format=xml

Query parameters

  type = image
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <max_size>5242880</max_size>  
    <allowed_types>
      <i0>gif</i0>  
      <i1>jpg</i1>  
      <i2>png</i2>  
      <i3>svg</i3>  
      <i4>webp</i4>  
    </allowed_types>  
    <allowed_mimes>
      <i0>image/gif</i0>  
      <i1>image/jpeg</i1>  
      <i2>image/jpg</i2>  
      <i3>image/pjpeg</i3>  
      <i4>image/x-png</i4>  
      <i5>image/png</i5>  
      <i6>image/svg+xml</i6>  
      <i7>application/svg+xml</i7>  
      <i8>image/webp</i8>  
    </allowed_mimes>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/cdns/property?type=image&format=txt

Query parameters

  type = image
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_max_size=5242880
result_allowed_types_0=gif
result_allowed_types_1=jpg
result_allowed_types_2=png
result_allowed_types_3=svg
result_allowed_types_4=webp
result_allowed_mimes_0=image/gif
result_allowed_mimes_1=image/jpeg
result_allowed_mimes_2=image/jpg
result_allowed_mimes_3=image/pjpeg
result_allowed_mimes_4=image/x-png
result_allowed_mimes_5=image/png
result_allowed_mimes_6=image/svg+xml
result_allowed_mimes_7=application/svg+xml
result_allowed_mimes_8=image/webp

Example 8 (plain)

Request

https://joturl.com/a/i1/cdns/property?type=image&format=plain

Query parameters

  type = image
format = plain

Response

5242880
gif
jpg
png
svg
webp
image/gif
image/jpeg
image/jpg
image/pjpeg
image/x-png
image/png
image/svg+xml
application/svg+xml
image/webp
Optional parameters
parameterdescription
typeSTRINGCDN resource type, available types: image
Return values
parameterdescription
[ARRAY]it is an object (type,(max_size,allowed_types,allowed_mimes)), see parameters max_size, allowed_types, allowed_mimes for details
allowed_mimesarray containing the allowed mimes for the resource
allowed_typesarray containing the allowed types for the resource
max_sizeit is the maximum size in bytes the resource can have

/conversions

/conversions/affiliates

/conversions/affiliates/count

access: [READ]

This method returns the number of affiliates.

Example 1 (json)

Request

https://joturl.com/a/i1/conversions/affiliates/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 5
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/conversions/affiliates/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>5</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/conversions/affiliates/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=5

Example 4 (plain)

Request

https://joturl.com/a/i1/conversions/affiliates/count?format=plain

Query parameters

format = plain

Response

5
Optional parameters
parameterdescription
idIDID of the affiliate network
Return values
parameterdescription
countnumber of affiliate networks

/conversions/affiliates/list

access: [READ]

This method lists all affiliates network.

Example 1 (json)

Request

https://joturl.com/a/i1/conversions/affiliates/list

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": {
      "id": "644a4b356f74446f62613864764b3762725a343966673d3d",
      "name": "Network name",
      "actual_url_params": "id={:CLICK_ID:}",
      "postback_url_params": "clickid={id}&comm={comm}",
      "integration_link": ""
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/conversions/affiliates/list?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <id>644a4b356f74446f62613864764b3762725a343966673d3d</id>  
      <name>Network name</name>  
      <actual_url_params>id={:CLICK_ID:}</actual_url_params>  
      <postback_url_params><[CDATA[clickid={id}&amp;comm={comm}]]></postback_url_params>  
      <integration_link></integration_link>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/conversions/affiliates/list?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_id=644a4b356f74446f62613864764b3762725a343966673d3d
result_data_name=Network name
result_data_actual_url_params=id={:CLICK_ID:}
result_data_postback_url_params=clickid={id}&amp;comm={comm}
result_data_integration_link=

Example 4 (plain)

Request

https://joturl.com/a/i1/conversions/affiliates/list?format=plain

Query parameters

format = plain

Response

644a4b356f74446f62613864764b3762725a343966673d3d
Network name
id={:CLICK_ID:}
clickid={id}&amp;comm={comm}

Optional parameters
parameterdescription
idIDID of the affiliate network
lengthINTEGERnumber of items to return (default: 1000, max value: 1000)
searchSTRINGfilter items by searching them
startINTEGERindex of the starting item to retrieve (default: 0)
Return values
parameterdescription
countnumber of affiliate networks
dataarray containing affiliate networks

/conversions/codes

/conversions/codes/add

access: [WRITE]

Create a conversion code for the logged user.

Example 1 (json)

Request

https://joturl.com/a/i1/conversions/codes/add?name=name+of+the+new+conversion+code¬es=this+is+a+note+for+the+conversion+code

Query parameters

 name = name of the new conversion code
notes = this is a note for the conversion code

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "name": "name of the new conversion code",
    "notes": "this is a note for the conversion code",
    "id": "61d5b6118f2c20ac3bc136a8ff0c9423",
    "enable_postback_url": 0,
    "affiliate_network_id": ""
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/conversions/codes/add?name=name+of+the+new+conversion+code¬es=this+is+a+note+for+the+conversion+code&format=xml

Query parameters

  name = name of the new conversion code
 notes = this is a note for the conversion code
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <name>name of the new conversion code</name>  
    <notes>this is a note for the conversion code</notes>  
    <id>61d5b6118f2c20ac3bc136a8ff0c9423</id>  
    <enable_postback_url>0</enable_postback_url>  
    <affiliate_network_id></affiliate_network_id>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/conversions/codes/add?name=name+of+the+new+conversion+code¬es=this+is+a+note+for+the+conversion+code&format=txt

Query parameters

  name = name of the new conversion code
 notes = this is a note for the conversion code
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_name=name of the new conversion code
result_notes=this is a note for the conversion code
result_id=61d5b6118f2c20ac3bc136a8ff0c9423
result_enable_postback_url=0
result_affiliate_network_id=

Example 4 (plain)

Request

https://joturl.com/a/i1/conversions/codes/add?name=name+of+the+new+conversion+code¬es=this+is+a+note+for+the+conversion+code&format=plain

Query parameters

  name = name of the new conversion code
 notes = this is a note for the conversion code
format = plain

Response

name of the new conversion code
this is a note for the conversion code
61d5b6118f2c20ac3bc136a8ff0c9423
0

Required parameters
parameterdescriptionmax length
nameSTRINGconversion name100
Optional parameters
parameterdescriptionmax length
affiliate_network_idIDID of the linked affiliate network, see i1/conversions/affliates/list for details
enable_postback_urlBOOLEAN1 to enable postback URLs for the conversion
notesSTRINGnotes for the conversion255
Return values
parameterdescription
affiliate_network_idecho back of the affiliate_network_id input parameter
enable_postback_urlecho back of the enable_postback_url input parameter
idID of the conversion code
nameecho back of the name input parameter
notesecho back of the notes input parameter

/conversions/codes/count

access: [READ]

This method returns the number of defined conversion codes.

Example 1 (json)

Request

https://joturl.com/a/i1/conversions/codes/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 4321
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/conversions/codes/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>4321</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/conversions/codes/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=4321

Example 4 (plain)

Request

https://joturl.com/a/i1/conversions/codes/count?format=plain

Query parameters

format = plain

Response

4321

Example 5 (json)

Request

https://joturl.com/a/i1/conversions/codes/count?search=text+to+search

Query parameters

search = text to search

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 1234
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/conversions/codes/count?search=text+to+search&format=xml

Query parameters

search = text to search
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>1234</count>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/conversions/codes/count?search=text+to+search&format=txt

Query parameters

search = text to search
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=1234

Example 8 (plain)

Request

https://joturl.com/a/i1/conversions/codes/count?search=text+to+search&format=plain

Query parameters

search = text to search
format = plain

Response

1234
Optional parameters
parameterdescription
searchSTRINGfilters conversion codes to be extracted by searching them
Return values
parameterdescription
countnumber of (filtered) conversion codes

/conversions/codes/delete

access: [WRITE]

This method deletes a set of conversion codes using their IDs.

Example 1 (json)

Request

https://joturl.com/a/i1/conversions/codes/delete?ids=b5174906b97efc24bbb5b2f77f062917,b352ffcd291842c124a2a98a499de0c8,1cb845bf83ca8a784c536f5d5a7c9651

Query parameters

ids = b5174906b97efc24bbb5b2f77f062917,b352ffcd291842c124a2a98a499de0c8,1cb845bf83ca8a784c536f5d5a7c9651

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 3
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/conversions/codes/delete?ids=b5174906b97efc24bbb5b2f77f062917,b352ffcd291842c124a2a98a499de0c8,1cb845bf83ca8a784c536f5d5a7c9651&format=xml

Query parameters

   ids = b5174906b97efc24bbb5b2f77f062917,b352ffcd291842c124a2a98a499de0c8,1cb845bf83ca8a784c536f5d5a7c9651
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>3</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/conversions/codes/delete?ids=b5174906b97efc24bbb5b2f77f062917,b352ffcd291842c124a2a98a499de0c8,1cb845bf83ca8a784c536f5d5a7c9651&format=txt

Query parameters

   ids = b5174906b97efc24bbb5b2f77f062917,b352ffcd291842c124a2a98a499de0c8,1cb845bf83ca8a784c536f5d5a7c9651
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=3

Example 4 (plain)

Request

https://joturl.com/a/i1/conversions/codes/delete?ids=b5174906b97efc24bbb5b2f77f062917,b352ffcd291842c124a2a98a499de0c8,1cb845bf83ca8a784c536f5d5a7c9651&format=plain

Query parameters

   ids = b5174906b97efc24bbb5b2f77f062917,b352ffcd291842c124a2a98a499de0c8,1cb845bf83ca8a784c536f5d5a7c9651
format = plain

Response

3

Example 5 (json)

Request

https://joturl.com/a/i1/conversions/codes/delete?ids=8e23916603f403fba8679b10dd753498,eac5b36d259cb95280ffd40dd9299448,9bb14e9828c4ea8ed72f10eefcdc582c

Query parameters

ids = 8e23916603f403fba8679b10dd753498,eac5b36d259cb95280ffd40dd9299448,9bb14e9828c4ea8ed72f10eefcdc582c

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "ids": [
      "8e23916603f403fba8679b10dd753498"
    ],
    "deleted": 2
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/conversions/codes/delete?ids=8e23916603f403fba8679b10dd753498,eac5b36d259cb95280ffd40dd9299448,9bb14e9828c4ea8ed72f10eefcdc582c&format=xml

Query parameters

   ids = 8e23916603f403fba8679b10dd753498,eac5b36d259cb95280ffd40dd9299448,9bb14e9828c4ea8ed72f10eefcdc582c
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <ids>
      <i0>8e23916603f403fba8679b10dd753498</i0>  
    </ids>  
    <deleted>2</deleted>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/conversions/codes/delete?ids=8e23916603f403fba8679b10dd753498,eac5b36d259cb95280ffd40dd9299448,9bb14e9828c4ea8ed72f10eefcdc582c&format=txt

Query parameters

   ids = 8e23916603f403fba8679b10dd753498,eac5b36d259cb95280ffd40dd9299448,9bb14e9828c4ea8ed72f10eefcdc582c
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_ids_0=8e23916603f403fba8679b10dd753498
result_deleted=2

Example 8 (plain)

Request

https://joturl.com/a/i1/conversions/codes/delete?ids=8e23916603f403fba8679b10dd753498,eac5b36d259cb95280ffd40dd9299448,9bb14e9828c4ea8ed72f10eefcdc582c&format=plain

Query parameters

   ids = 8e23916603f403fba8679b10dd753498,eac5b36d259cb95280ffd40dd9299448,9bb14e9828c4ea8ed72f10eefcdc582c
format = plain

Response

8e23916603f403fba8679b10dd753498
2
Required parameters
parameterdescription
idsARRAY_OF_IDScomma-separated list of conversion code IDs to be deleted
Return values
parameterdescription
deletednumber of deleted conversion codes
ids[OPTIONAL] list of conversion code IDs whose delete has failed, this parameter is returned only when at least one delete error has occurred

/conversions/codes/edit

access: [WRITE]

Edit fields of a conversion.

Example 1 (json)

Request

https://joturl.com/a/i1/conversions/codes/edit?id=026012e378b5d55891550bec39412d58¬es=new+notes+for+the+conversion+code

Query parameters

   id = 026012e378b5d55891550bec39412d58
notes = new notes for the conversion code

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "026012e378b5d55891550bec39412d58",
    "notes": "new notes for the conversion code"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/conversions/codes/edit?id=026012e378b5d55891550bec39412d58¬es=new+notes+for+the+conversion+code&format=xml

Query parameters

    id = 026012e378b5d55891550bec39412d58
 notes = new notes for the conversion code
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>026012e378b5d55891550bec39412d58</id>  
    <notes>new notes for the conversion code</notes>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/conversions/codes/edit?id=026012e378b5d55891550bec39412d58¬es=new+notes+for+the+conversion+code&format=txt

Query parameters

    id = 026012e378b5d55891550bec39412d58
 notes = new notes for the conversion code
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=026012e378b5d55891550bec39412d58
result_notes=new notes for the conversion code

Example 4 (plain)

Request

https://joturl.com/a/i1/conversions/codes/edit?id=026012e378b5d55891550bec39412d58¬es=new+notes+for+the+conversion+code&format=plain

Query parameters

    id = 026012e378b5d55891550bec39412d58
 notes = new notes for the conversion code
format = plain

Response

026012e378b5d55891550bec39412d58
new notes for the conversion code
Required parameters
parameterdescription
idIDID of the conversion code
Optional parameters
parameterdescriptionmax length
affiliate_network_idIDID of the affiliate network linked to the conversion code, it is ignored if enable_postback_url = 0
enable_postback_urlBOOLEAN1 to enabled postback URLs for the conversion code, 0 to disable it
nameSTRINGname of the conversion code100
notesSTRINGnotes for the conversion code255
Return values
parameterdescription
affiliate_network_id[OPTIONAL] echo back of the affiliate_network_id input parameter
enable_postback_url[OPTIONAL] echo back of the enable_postback_url input parameter
idecho back of the id input parameter
name[OPTIONAL] echo back of the name input parameter
notes[OPTIONAL] echo back of the notes input parameter

/conversions/codes/info

access: [READ]

This method returns information about conversion code.

Example 1 (json)

Request

https://joturl.com/a/i1/conversions/codes/info?id=9440f13dc1abbdd883549de973ed9c90&fields=id,name,notes

Query parameters

    id = 9440f13dc1abbdd883549de973ed9c90
fields = id,name,notes

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "9440f13dc1abbdd883549de973ed9c90",
    "name": "name",
    "notes": "notes"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/conversions/codes/info?id=9440f13dc1abbdd883549de973ed9c90&fields=id,name,notes&format=xml

Query parameters

    id = 9440f13dc1abbdd883549de973ed9c90
fields = id,name,notes
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>9440f13dc1abbdd883549de973ed9c90</id>  
    <name>name</name>  
    <notes>notes</notes>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/conversions/codes/info?id=9440f13dc1abbdd883549de973ed9c90&fields=id,name,notes&format=txt

Query parameters

    id = 9440f13dc1abbdd883549de973ed9c90
fields = id,name,notes
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=9440f13dc1abbdd883549de973ed9c90
result_name=name
result_notes=notes

Example 4 (plain)

Request

https://joturl.com/a/i1/conversions/codes/info?id=9440f13dc1abbdd883549de973ed9c90&fields=id,name,notes&format=plain

Query parameters

    id = 9440f13dc1abbdd883549de973ed9c90
fields = id,name,notes
format = plain

Response

9440f13dc1abbdd883549de973ed9c90
name
notes
Required parameters
parameterdescription
fieldsARRAYcomma separated list of fields to return, available fields: id, ext_id, ext_postback_id, name, notes, enable_postback_url, affiliate_network_id, creation, clicks, last_click, value, performance
idIDconversion ID
Return values
parameterdescription
[ARRAY]see i1/conversions/codes/list for details on returned fields

/conversions/codes/list

access: [READ]

This method returns a list of user's conversions, specified in a comma separated input called fields.

Example 1 (json)

Request

https://joturl.com/a/i1/conversions/codes/list?fields=count,id,name

Query parameters

fields = count,id,name

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 3,
    "data": [
      {
        "id": "a0fd6a86a2486f6d4ba8dbe354b3b0da",
        "name": "conversion code 1"
      },
      {
        "id": "55e2ecf6e1ef523f549bf700f348f672",
        "name": "conversion code 2"
      },
      {
        "id": "a9988b39fd863d9a4e5f2ec3f9a7b5e0",
        "name": "conversion code 3"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/conversions/codes/list?fields=count,id,name&format=xml

Query parameters

fields = count,id,name
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>3</count>  
    <data>
      <i0>
        <id>a0fd6a86a2486f6d4ba8dbe354b3b0da</id>  
        <name>conversion code 1</name>  
      </i0>  
      <i1>
        <id>55e2ecf6e1ef523f549bf700f348f672</id>  
        <name>conversion code 2</name>  
      </i1>  
      <i2>
        <id>a9988b39fd863d9a4e5f2ec3f9a7b5e0</id>  
        <name>conversion code 3</name>  
      </i2>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/conversions/codes/list?fields=count,id,name&format=txt

Query parameters

fields = count,id,name
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=3
result_data_0_id=a0fd6a86a2486f6d4ba8dbe354b3b0da
result_data_0_name=conversion code 1
result_data_1_id=55e2ecf6e1ef523f549bf700f348f672
result_data_1_name=conversion code 2
result_data_2_id=a9988b39fd863d9a4e5f2ec3f9a7b5e0
result_data_2_name=conversion code 3

Example 4 (plain)

Request

https://joturl.com/a/i1/conversions/codes/list?fields=count,id,name&format=plain

Query parameters

fields = count,id,name
format = plain

Response

3
a0fd6a86a2486f6d4ba8dbe354b3b0da
conversion code 1
55e2ecf6e1ef523f549bf700f348f672
conversion code 2
a9988b39fd863d9a4e5f2ec3f9a7b5e0
conversion code 3
Required parameters
parameterdescription
fieldsARRAYcomma separated list of fields to return, available fields: count, id, ext_id, ext_postback_id, name, notes, enable_postback_url, affiliate_network_id, creation, clicks, last_click, value, performance
Optional parameters
parameterdescription
lengthINTEGERextracts this number of coversion codes (maxmimum allowed: 100)
orderbyARRAYorders coversion codes by field, available fields: count, id, ext_id, ext_postback_id, name, notes, enable_postback_url, affiliate_network_id, creation, clicks, last_click, value, performance
searchSTRINGfilters coversion codes to be extracted by searching them
sortSTRINGsorts coversion codes in ascending (ASC) or descending (DESC) order
startINTEGERstarts to extract coversion codes from this position
Return values
parameterdescription
count[OPTIONAL] total number of (filtered) coversion codes, returned only if count is passed in fields
dataarray containing required information on coversion codes

/conversions/codes/params

/conversions/codes/params/count

access: [READ]

This method returns the number of parameters linked to a conversion code.

Example 1 (json)

Request

https://joturl.com/a/i1/conversions/codes/params/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 4
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/conversions/codes/params/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>4</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/conversions/codes/params/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=4

Example 4 (plain)

Request

https://joturl.com/a/i1/conversions/codes/params/count?format=plain

Query parameters

format = plain

Response

4
Required parameters
parameterdescription
idIDID of the conversion code
Optional parameters
parameterdescription
param_numSTRINGfilter conversion parameters by parameter number, see i1/conversions/codes/params/list for details
searchSTRINGfilters conversion parameters to be extracted by searching them
Return values
parameterdescription
countnumber of (filtered) conversion parameters
/conversions/codes/params/has_params

access: [READ]

This method returns the number of parameters related to a conversion code.

Example 1 (json)

Request

https://joturl.com/a/i1/conversions/codes/params/has_params?id=761bb45d2a9fd95ea5c68283d915bf94

Query parameters

id = 761bb45d2a9fd95ea5c68283d915bf94

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "has_params": 1,
    "param": 1,
    "ep00": 1,
    "ep01": 0,
    "ep02": 0,
    "ep03": 0,
    "ep04": 0,
    "ep05": 0,
    "ep06": 0,
    "ep07": 0,
    "ep08": 0,
    "ep09": 0,
    "ep10": 0,
    "ep11": 0,
    "ep12": 0,
    "ep13": 0,
    "ep14": 0
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/conversions/codes/params/has_params?id=761bb45d2a9fd95ea5c68283d915bf94&format=xml

Query parameters

    id = 761bb45d2a9fd95ea5c68283d915bf94
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <has_params>1</has_params>  
    <param>1</param>  
    <ep00>1</ep00>  
    <ep01>0</ep01>  
    <ep02>0</ep02>  
    <ep03>0</ep03>  
    <ep04>0</ep04>  
    <ep05>0</ep05>  
    <ep06>0</ep06>  
    <ep07>0</ep07>  
    <ep08>0</ep08>  
    <ep09>0</ep09>  
    <ep10>0</ep10>  
    <ep11>0</ep11>  
    <ep12>0</ep12>  
    <ep13>0</ep13>  
    <ep14>0</ep14>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/conversions/codes/params/has_params?id=761bb45d2a9fd95ea5c68283d915bf94&format=txt

Query parameters

    id = 761bb45d2a9fd95ea5c68283d915bf94
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_has_params=1
result_param=1
result_ep00=1
result_ep01=0
result_ep02=0
result_ep03=0
result_ep04=0
result_ep05=0
result_ep06=0
result_ep07=0
result_ep08=0
result_ep09=0
result_ep10=0
result_ep11=0
result_ep12=0
result_ep13=0
result_ep14=0

Example 4 (plain)

Request

https://joturl.com/a/i1/conversions/codes/params/has_params?id=761bb45d2a9fd95ea5c68283d915bf94&format=plain

Query parameters

    id = 761bb45d2a9fd95ea5c68283d915bf94
format = plain

Response

1
1
1
0
0
0
0
0
0
0
0
0
0
0
0
0
0
Required parameters
parameterdescription
idIDID of the conversion code
Return values
parameterdescription
ep001 if the extended parameter ep00 is associated to the conversion code
ep011 if the extended parameter ep01 is associated to the conversion code
ep021 if the extended parameter ep02 is associated to the conversion code
ep031 if the extended parameter ep03 is associated to the conversion code
ep041 if the extended parameter ep04 is associated to the conversion code
ep051 if the extended parameter ep05 is associated to the conversion code
ep061 if the extended parameter ep06 is associated to the conversion code
ep071 if the extended parameter ep07 is associated to the conversion code
ep081 if the extended parameter ep08 is associated to the conversion code
ep091 if the extended parameter ep09 is associated to the conversion code
ep101 if the extended parameter ep10 is associated to the conversion code
ep111 if the extended parameter ep11 is associated to the conversion code
ep121 if the extended parameter ep12 is associated to the conversion code
ep131 if the extended parameter ep13 is associated to the conversion code
ep141 if the extended parameter ep14 is associated to the conversion code
has_params1 if at least one extended parameter is associated to the conversion code
param1 if param is associated to the conversion code
/conversions/codes/params/list

access: [READ]

This method returns a list of parameters related to a conversion code.

Example 1 (json)

Request

https://joturl.com/a/i1/conversions/codes/params/list?id=d23c5fc517189ab0ccef380e2325ae46

Query parameters

id = d23c5fc517189ab0ccef380e2325ae46

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 2,
    "data": [
      {
        "param_id": "f6ff047aafd680df551a4c36edab8442",
        "param": "this is the value #1 of parameter 'param'"
      },
      {
        "param_id": "4d10189a098c05edf8ef8722989852bd",
        "param": "this is the value #2 of parameter 'param'"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/conversions/codes/params/list?id=d23c5fc517189ab0ccef380e2325ae46&format=xml

Query parameters

    id = d23c5fc517189ab0ccef380e2325ae46
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>2</count>  
    <data>
      <i0>
        <param_id>f6ff047aafd680df551a4c36edab8442</param_id>  
        <param>this is the value #1 of parameter 'param'</param>  
      </i0>  
      <i1>
        <param_id>4d10189a098c05edf8ef8722989852bd</param_id>  
        <param>this is the value #2 of parameter 'param'</param>  
      </i1>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/conversions/codes/params/list?id=d23c5fc517189ab0ccef380e2325ae46&format=txt

Query parameters

    id = d23c5fc517189ab0ccef380e2325ae46
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=2
result_data_0_param_id=f6ff047aafd680df551a4c36edab8442
result_data_0_param=this is the value #1 of parameter 'param'
result_data_1_param_id=4d10189a098c05edf8ef8722989852bd
result_data_1_param=this is the value #2 of parameter 'param'

Example 4 (plain)

Request

https://joturl.com/a/i1/conversions/codes/params/list?id=d23c5fc517189ab0ccef380e2325ae46&format=plain

Query parameters

    id = d23c5fc517189ab0ccef380e2325ae46
format = plain

Response

2
f6ff047aafd680df551a4c36edab8442
this is the value #1 of parameter 'param'
4d10189a098c05edf8ef8722989852bd
this is the value #2 of parameter 'param'

Example 5 (json)

Request

https://joturl.com/a/i1/conversions/codes/params/list?id=540d9355ab660ab78d9989ae4956baea¶m_num=0

Query parameters

       id = 540d9355ab660ab78d9989ae4956baea
param_num = 0

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 1,
    "data": [
      {
        "param_id": "dc201d2fa419310c342be85d9993edec",
        "param": "this is the value of extended parameter 'ep00'"
      }
    ]
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/conversions/codes/params/list?id=540d9355ab660ab78d9989ae4956baea¶m_num=0&format=xml

Query parameters

       id = 540d9355ab660ab78d9989ae4956baea
param_num = 0
   format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>1</count>  
    <data>
      <i0>
        <param_id>dc201d2fa419310c342be85d9993edec</param_id>  
        <param>this is the value of extended parameter 'ep00'</param>  
      </i0>  
    </data>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/conversions/codes/params/list?id=540d9355ab660ab78d9989ae4956baea¶m_num=0&format=txt

Query parameters

       id = 540d9355ab660ab78d9989ae4956baea
param_num = 0
   format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=1
result_data_0_param_id=dc201d2fa419310c342be85d9993edec
result_data_0_param=this is the value of extended parameter 'ep00'

Example 8 (plain)

Request

https://joturl.com/a/i1/conversions/codes/params/list?id=540d9355ab660ab78d9989ae4956baea¶m_num=0&format=plain

Query parameters

       id = 540d9355ab660ab78d9989ae4956baea
param_num = 0
   format = plain

Response

1
dc201d2fa419310c342be85d9993edec
this is the value of extended parameter 'ep00'
Required parameters
parameterdescription
idIDID of the conversion code
Optional parameters
parameterdescription
lengthINTEGERextracts this number of coversion parameters (maxmimum allowed: 100)
param_numSTRINGif not passed or param_num = 255 it returns the parameter param, if param_num = 0 it returns the extended paarameter ep00, ..., if param_num = 7 it returns the extended paarameter ep07, ..., if param_num = 14 it returns the extended paarameter ep14,
searchSTRINGfilters coversion parameters to be extracted by searching them
startINTEGERstarts to extract coversion parameters from this position
Return values
parameterdescription
countnumber of available parameter with the specified param_num
dataarray containing required information on coversion code parameters

/conversions/codes/urls

/conversions/codes/urls/count

access: [READ]

This method returns the number of tracking links liked to a conversion code.

Example 1 (json)

Request

https://joturl.com/a/i1/conversions/codes/urls/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 2
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/conversions/codes/urls/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>2</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/conversions/codes/urls/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=2

Example 4 (plain)

Request

https://joturl.com/a/i1/conversions/codes/urls/count?format=plain

Query parameters

format = plain

Response

2
Required parameters
parameterdescription
idIDID of the conversion code
Optional parameters
parameterdescription
searchSTRINGfilters tracking pixels to be extracted by searching them
Return values
parameterdescription
countnumber of (filtered) tracking pixels
/conversions/codes/urls/list

access: [READ]

This method returns a list of tracking links related to a conversion code.

Example 1 (json)

Request

https://joturl.com/a/i1/conversions/codes/urls/list?id=9b40be4e090847b08479a20b84b50297&fields=count,url_id,alias

Query parameters

    id = 9b40be4e090847b08479a20b84b50297
fields = count,url_id,alias

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 2,
    "data": [
      {
        "url_id": "392a8625aa1eda10e3f002528aa9177c",
        "alias": "73c2e803"
      },
      {
        "url_id": "f338860ed96feca2f9b7b7762b531b1f",
        "alias": "635194f9"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/conversions/codes/urls/list?id=9b40be4e090847b08479a20b84b50297&fields=count,url_id,alias&format=xml

Query parameters

    id = 9b40be4e090847b08479a20b84b50297
fields = count,url_id,alias
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>2</count>  
    <data>
      <i0>
        <url_id>392a8625aa1eda10e3f002528aa9177c</url_id>  
        <alias>73c2e803</alias>  
      </i0>  
      <i1>
        <url_id>f338860ed96feca2f9b7b7762b531b1f</url_id>  
        <alias>635194f9</alias>  
      </i1>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/conversions/codes/urls/list?id=9b40be4e090847b08479a20b84b50297&fields=count,url_id,alias&format=txt

Query parameters

    id = 9b40be4e090847b08479a20b84b50297
fields = count,url_id,alias
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=2
result_data_0_url_id=392a8625aa1eda10e3f002528aa9177c
result_data_0_alias=73c2e803
result_data_1_url_id=f338860ed96feca2f9b7b7762b531b1f
result_data_1_alias=635194f9

Example 4 (plain)

Request

https://joturl.com/a/i1/conversions/codes/urls/list?id=9b40be4e090847b08479a20b84b50297&fields=count,url_id,alias&format=plain

Query parameters

    id = 9b40be4e090847b08479a20b84b50297
fields = count,url_id,alias
format = plain

Response

2
392a8625aa1eda10e3f002528aa9177c
73c2e803
f338860ed96feca2f9b7b7762b531b1f
635194f9
Required parameters
parameterdescription
fieldsARRAYcomma-separated list of fields to return, available fields: count, url_id, alias, short_url, creation, long_url, domain_host, domain_id, project_name, project_id
idIDID of the conversion code
Optional parameters
parameterdescription
lengthINTEGERextracts this number of tracking links (maxmimum allowed: 100)
orderbyARRAYorders tracking links by field, available fields: url_id, alias, short_url, creation, long_url, domain_host, domain_id, project_name, project_id
searchSTRINGfilters tracking links to be extracted by searching them
sortSTRINGsorts tracking links in ascending (ASC) or descending (DESC) order
startINTEGERstarts to extract tracking links from this position
Return values
parameterdescription
count[OPTIONAL] total number of tracking links, returned only if count is passed in fields
dataarray containing information on the tracking links, the returned information depends on the fields parameter.

/conversions/count

access: [READ]

This method is actually an interface to i1/conversions/codes/count and/or to i1/conversions/pixels/count according to types.

Example 1 (json)

Request

https://joturl.com/a/i1/conversions/count?types=code,pixel

Query parameters

types = code,pixel

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 727
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/conversions/count?types=code,pixel&format=xml

Query parameters

 types = code,pixel
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>727</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/conversions/count?types=code,pixel&format=txt

Query parameters

 types = code,pixel
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=727

Example 4 (plain)

Request

https://joturl.com/a/i1/conversions/count?types=code,pixel&format=plain

Query parameters

 types = code,pixel
format = plain

Response

727
Required parameters
parameterdescription
typesARRAYcomma separated list of types; available types are [code, pixel]
Return values
parameterdescription
countnumber of conversion, if both types are passed, it contains the sum of number of conversion codes and conversion pixels

/conversions/list

access: [READ]

This method is actually an interface to i1/conversions/codes/list and/or to i1/conversions/pixels/list according to types.

Example 1 (json)

Request

https://joturl.com/a/i1/conversions/list?types=code,pixel&fields=name,id,short_url

Query parameters

 types = code,pixel
fields = name,id,short_url

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": [
      {
        "name": "conversion code 1 (postback enabled)",
        "id": "00572cab1fb0c5de99d54fec64ad709c",
        "ext_id": "4a5dfbf83c9cd65d2316269309228b90",
        "ext_postback_id": "250c3e7c6378dcb91a8861ca5222cda9",
        "type": "code"
      },
      {
        "name": "conversion code 2",
        "id": "b35f711e7fa8ba3bfcb4baaf305d3261",
        "ext_id": "90933a0dba97c82d8e2e0c0bdd8d0afd",
        "type": "code"
      },
      {
        "id": "6470193a8d9b9cdaaf916d0a86343650",
        "short_url": "https:\/\/domain.ext\/tracking_pixel_alias",
        "type": "pixel"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/conversions/list?types=code,pixel&fields=name,id,short_url&format=xml

Query parameters

 types = code,pixel
fields = name,id,short_url
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <i0>
        <name>conversion code 1 (postback enabled)</name>  
        <id>00572cab1fb0c5de99d54fec64ad709c</id>  
        <ext_id>4a5dfbf83c9cd65d2316269309228b90</ext_id>  
        <ext_postback_id>250c3e7c6378dcb91a8861ca5222cda9</ext_postback_id>  
        <type>code</type>  
      </i0>  
      <i1>
        <name>conversion code 2</name>  
        <id>b35f711e7fa8ba3bfcb4baaf305d3261</id>  
        <ext_id>90933a0dba97c82d8e2e0c0bdd8d0afd</ext_id>  
        <type>code</type>  
      </i1>  
      <i2>
        <id>6470193a8d9b9cdaaf916d0a86343650</id>  
        <short_url>https://domain.ext/tracking_pixel_alias</short_url>  
        <type>pixel</type>  
      </i2>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/conversions/list?types=code,pixel&fields=name,id,short_url&format=txt

Query parameters

 types = code,pixel
fields = name,id,short_url
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_0_name=conversion code 1 (postback enabled)
result_data_0_id=00572cab1fb0c5de99d54fec64ad709c
result_data_0_ext_id=4a5dfbf83c9cd65d2316269309228b90
result_data_0_ext_postback_id=250c3e7c6378dcb91a8861ca5222cda9
result_data_0_type=code
result_data_1_name=conversion code 2
result_data_1_id=b35f711e7fa8ba3bfcb4baaf305d3261
result_data_1_ext_id=90933a0dba97c82d8e2e0c0bdd8d0afd
result_data_1_type=code
result_data_2_id=6470193a8d9b9cdaaf916d0a86343650
result_data_2_short_url=https://domain.ext/tracking_pixel_alias
result_data_2_type=pixel

Example 4 (plain)

Request

https://joturl.com/a/i1/conversions/list?types=code,pixel&fields=name,id,short_url&format=plain

Query parameters

 types = code,pixel
fields = name,id,short_url
format = plain

Response

conversion code 1 (postback enabled)
00572cab1fb0c5de99d54fec64ad709c
4a5dfbf83c9cd65d2316269309228b90
250c3e7c6378dcb91a8861ca5222cda9
code
conversion code 2
b35f711e7fa8ba3bfcb4baaf305d3261
90933a0dba97c82d8e2e0c0bdd8d0afd
code
https://domain.ext/tracking_pixel_alias
Required parameters
parameterdescription
typesARRAYcomma separated list of types; available types are [code, pixel]
Return values
parameterdescription
count[OPTIONAL] number of conversion, if both types are passed, it contains the sum of number of conversion codes and conversion pixels
dataarray containing information on conversions

/conversions/pixels

/conversions/pixels/add

access: [WRITE]

Add a tracking pixel for the logged user.

Example 1 (json)

Request

https://joturl.com/a/i1/conversions/pixels/add?alias=jot&domain_id=860644496eb04e5e5c98d2b50c4dbccc&url_project_id=a3f2fb9b19b9494c9410237566a7117d¬es=

Query parameters

         alias = jot
     domain_id = 860644496eb04e5e5c98d2b50c4dbccc
url_project_id = a3f2fb9b19b9494c9410237566a7117d
         notes = 

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "1d5a42fc37ec0e8ab5742bb97bfaab33",
    "alias": "jot",
    "domain_id": "860644496eb04e5e5c98d2b50c4dbccc",
    "domain_host": "jo.my",
    "domain_nickname": "",
    "url_project_id": "a3f2fb9b19b9494c9410237566a7117d",
    "project_name": "project name",
    "short_url": "\/\/jo.my\/jot",
    "template_type": 2,
    "notes": ""
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/conversions/pixels/add?alias=jot&domain_id=860644496eb04e5e5c98d2b50c4dbccc&url_project_id=a3f2fb9b19b9494c9410237566a7117d¬es=&format=xml

Query parameters

         alias = jot
     domain_id = 860644496eb04e5e5c98d2b50c4dbccc
url_project_id = a3f2fb9b19b9494c9410237566a7117d
         notes = 
        format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>1d5a42fc37ec0e8ab5742bb97bfaab33</id>  
    <alias>jot</alias>  
    <domain_id>860644496eb04e5e5c98d2b50c4dbccc</domain_id>  
    <domain_host>jo.my</domain_host>  
    <domain_nickname></domain_nickname>  
    <url_project_id>a3f2fb9b19b9494c9410237566a7117d</url_project_id>  
    <project_name>project name</project_name>  
    <short_url>//jo.my/jot</short_url>  
    <template_type>2</template_type>  
    <notes></notes>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/conversions/pixels/add?alias=jot&domain_id=860644496eb04e5e5c98d2b50c4dbccc&url_project_id=a3f2fb9b19b9494c9410237566a7117d¬es=&format=txt

Query parameters

         alias = jot
     domain_id = 860644496eb04e5e5c98d2b50c4dbccc
url_project_id = a3f2fb9b19b9494c9410237566a7117d
         notes = 
        format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=1d5a42fc37ec0e8ab5742bb97bfaab33
result_alias=jot
result_domain_id=860644496eb04e5e5c98d2b50c4dbccc
result_domain_host=jo.my
result_domain_nickname=
result_url_project_id=a3f2fb9b19b9494c9410237566a7117d
result_project_name=project name
result_short_url=//jo.my/jot
result_template_type=2
result_notes=

Example 4 (plain)

Request

https://joturl.com/a/i1/conversions/pixels/add?alias=jot&domain_id=860644496eb04e5e5c98d2b50c4dbccc&url_project_id=a3f2fb9b19b9494c9410237566a7117d¬es=&format=plain

Query parameters

         alias = jot
     domain_id = 860644496eb04e5e5c98d2b50c4dbccc
url_project_id = a3f2fb9b19b9494c9410237566a7117d
         notes = 
        format = plain

Response

//jo.my/jot
Required parameters
parameterdescriptionmax length
aliasSTRINGalias for the tracking pixel, see i1/urls/shorten for details of available characters in alias510
Optional parameters
parameterdescription
conversion_idsARRAY_OF_IDSID of the associated conversion codes
domain_idIDID of the domain for the tracking pixel, if not set the default domain for the user will be used
notesSTRINGnotes for the tracking pixel
tagsARRAYcomma-separated list of tags for the tracking pixel
url_project_idIDID of the project where the tracking pixel will be put in, if not specified the default: project is used
Return values
parameterdescription
aliassee i1/urls/shorten for details on returnd fields
domain_hostsee i1/urls/shorten for details on returnd fields
domain_idsee i1/urls/shorten for details on returnd fields
domain_nicknamesee i1/urls/shorten for details on returnd fields
idID of the created tracking pixel
notessee i1/urls/shorten for details on returnd fields
project_idsee i1/urls/shorten for details on returnd fields
project_namesee i1/urls/shorten for details on returnd fields
short_urlsee i1/urls/shorten for details on returnd fields
tagssee i1/urls/shorten for details on returnd fields
tagssee i1/urls/shorten for details on returnd fields
url_conversions_numbernumber of associated conversion codes

/conversions/pixels/count

access: [READ]

This method returns the number of defined conversion pixels.

Example 1 (json)

Request

https://joturl.com/a/i1/conversions/pixels/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 2
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/conversions/pixels/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>2</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/conversions/pixels/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=2

Example 4 (plain)

Request

https://joturl.com/a/i1/conversions/pixels/count?format=plain

Query parameters

format = plain

Response

2
Optional parameters
parameterdescription
searchSTRINGfilters conversion pixels to be extracted by searching them
Return values
parameterdescription
countnumber of (filtered) conversion pixels

/conversions/pixels/delete

access: [WRITE]

This method deletes a set of conversion pixel using their IDs.

Example 1 (json)

Request

https://joturl.com/a/i1/conversions/pixels/delete?ids=4f08711693d6a984bb8a8313bcb3f3b2,8ee2109f7d1416d03ee8bdbc271636ea,3f0c680a1f978b3a42abe2356d8a4db7

Query parameters

ids = 4f08711693d6a984bb8a8313bcb3f3b2,8ee2109f7d1416d03ee8bdbc271636ea,3f0c680a1f978b3a42abe2356d8a4db7

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 3
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/conversions/pixels/delete?ids=4f08711693d6a984bb8a8313bcb3f3b2,8ee2109f7d1416d03ee8bdbc271636ea,3f0c680a1f978b3a42abe2356d8a4db7&format=xml

Query parameters

   ids = 4f08711693d6a984bb8a8313bcb3f3b2,8ee2109f7d1416d03ee8bdbc271636ea,3f0c680a1f978b3a42abe2356d8a4db7
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>3</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/conversions/pixels/delete?ids=4f08711693d6a984bb8a8313bcb3f3b2,8ee2109f7d1416d03ee8bdbc271636ea,3f0c680a1f978b3a42abe2356d8a4db7&format=txt

Query parameters

   ids = 4f08711693d6a984bb8a8313bcb3f3b2,8ee2109f7d1416d03ee8bdbc271636ea,3f0c680a1f978b3a42abe2356d8a4db7
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=3

Example 4 (plain)

Request

https://joturl.com/a/i1/conversions/pixels/delete?ids=4f08711693d6a984bb8a8313bcb3f3b2,8ee2109f7d1416d03ee8bdbc271636ea,3f0c680a1f978b3a42abe2356d8a4db7&format=plain

Query parameters

   ids = 4f08711693d6a984bb8a8313bcb3f3b2,8ee2109f7d1416d03ee8bdbc271636ea,3f0c680a1f978b3a42abe2356d8a4db7
format = plain

Response

3

Example 5 (json)

Request

https://joturl.com/a/i1/conversions/pixels/delete?ids=5f3b048c1b4aa99f6d834fdde2bba7ad,af8f8d84c1cfd55d6cdd62635612575f,0a6fc3a4f9995a424eee18f165f03478

Query parameters

ids = 5f3b048c1b4aa99f6d834fdde2bba7ad,af8f8d84c1cfd55d6cdd62635612575f,0a6fc3a4f9995a424eee18f165f03478

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "ids": [
      "5f3b048c1b4aa99f6d834fdde2bba7ad"
    ],
    "deleted": 2
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/conversions/pixels/delete?ids=5f3b048c1b4aa99f6d834fdde2bba7ad,af8f8d84c1cfd55d6cdd62635612575f,0a6fc3a4f9995a424eee18f165f03478&format=xml

Query parameters

   ids = 5f3b048c1b4aa99f6d834fdde2bba7ad,af8f8d84c1cfd55d6cdd62635612575f,0a6fc3a4f9995a424eee18f165f03478
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <ids>
      <i0>5f3b048c1b4aa99f6d834fdde2bba7ad</i0>  
    </ids>  
    <deleted>2</deleted>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/conversions/pixels/delete?ids=5f3b048c1b4aa99f6d834fdde2bba7ad,af8f8d84c1cfd55d6cdd62635612575f,0a6fc3a4f9995a424eee18f165f03478&format=txt

Query parameters

   ids = 5f3b048c1b4aa99f6d834fdde2bba7ad,af8f8d84c1cfd55d6cdd62635612575f,0a6fc3a4f9995a424eee18f165f03478
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_ids_0=5f3b048c1b4aa99f6d834fdde2bba7ad
result_deleted=2

Example 8 (plain)

Request

https://joturl.com/a/i1/conversions/pixels/delete?ids=5f3b048c1b4aa99f6d834fdde2bba7ad,af8f8d84c1cfd55d6cdd62635612575f,0a6fc3a4f9995a424eee18f165f03478&format=plain

Query parameters

   ids = 5f3b048c1b4aa99f6d834fdde2bba7ad,af8f8d84c1cfd55d6cdd62635612575f,0a6fc3a4f9995a424eee18f165f03478
format = plain

Response

5f3b048c1b4aa99f6d834fdde2bba7ad
2
Required parameters
parameterdescription
idsARRAY_OF_IDScomma-separated list of tracking pixel IDs to be deleted
Return values
parameterdescription
deletednumber of deleted tracking pixels
tracking_pixel_ids[OPTIONAL] list of tracking pixel IDs whose delete has failed, this parameter is returned only when at least one delete error has occurred

/conversions/pixels/edit

access: [WRITE]

Edit fields of a Tracking Pixel.

Example 1 (json)

Request

https://joturl.com/a/i1/conversions/pixels/edit?id=4902f9bb9af8be2099cdd1b305d6c7a5&alias=jot&domain_id=34f6cfd7e8596ddc38693a50fe8ddfbc&url_project_id=d211924e6bb71da3ad9889517abc675e¬es=new+notes

Query parameters

            id = 4902f9bb9af8be2099cdd1b305d6c7a5
         alias = jot
     domain_id = 34f6cfd7e8596ddc38693a50fe8ddfbc
url_project_id = d211924e6bb71da3ad9889517abc675e
         notes = new notes

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "4902f9bb9af8be2099cdd1b305d6c7a5",
    "alias": "jot",
    "domain_id": "34f6cfd7e8596ddc38693a50fe8ddfbc",
    "domain_host": "jo.my",
    "domain_nickname": "",
    "url_project_id": "d211924e6bb71da3ad9889517abc675e",
    "project_name": "project name",
    "short_url": "\/\/jo.my\/jot",
    "template_type": 2,
    "notes": "new notes"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/conversions/pixels/edit?id=4902f9bb9af8be2099cdd1b305d6c7a5&alias=jot&domain_id=34f6cfd7e8596ddc38693a50fe8ddfbc&url_project_id=d211924e6bb71da3ad9889517abc675e¬es=new+notes&format=xml

Query parameters

            id = 4902f9bb9af8be2099cdd1b305d6c7a5
         alias = jot
     domain_id = 34f6cfd7e8596ddc38693a50fe8ddfbc
url_project_id = d211924e6bb71da3ad9889517abc675e
         notes = new notes
        format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>4902f9bb9af8be2099cdd1b305d6c7a5</id>  
    <alias>jot</alias>  
    <domain_id>34f6cfd7e8596ddc38693a50fe8ddfbc</domain_id>  
    <domain_host>jo.my</domain_host>  
    <domain_nickname></domain_nickname>  
    <url_project_id>d211924e6bb71da3ad9889517abc675e</url_project_id>  
    <project_name>project name</project_name>  
    <short_url>//jo.my/jot</short_url>  
    <template_type>2</template_type>  
    <notes>new notes</notes>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/conversions/pixels/edit?id=4902f9bb9af8be2099cdd1b305d6c7a5&alias=jot&domain_id=34f6cfd7e8596ddc38693a50fe8ddfbc&url_project_id=d211924e6bb71da3ad9889517abc675e¬es=new+notes&format=txt

Query parameters

            id = 4902f9bb9af8be2099cdd1b305d6c7a5
         alias = jot
     domain_id = 34f6cfd7e8596ddc38693a50fe8ddfbc
url_project_id = d211924e6bb71da3ad9889517abc675e
         notes = new notes
        format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=4902f9bb9af8be2099cdd1b305d6c7a5
result_alias=jot
result_domain_id=34f6cfd7e8596ddc38693a50fe8ddfbc
result_domain_host=jo.my
result_domain_nickname=
result_url_project_id=d211924e6bb71da3ad9889517abc675e
result_project_name=project name
result_short_url=//jo.my/jot
result_template_type=2
result_notes=new notes

Example 4 (plain)

Request

https://joturl.com/a/i1/conversions/pixels/edit?id=4902f9bb9af8be2099cdd1b305d6c7a5&alias=jot&domain_id=34f6cfd7e8596ddc38693a50fe8ddfbc&url_project_id=d211924e6bb71da3ad9889517abc675e¬es=new+notes&format=plain

Query parameters

            id = 4902f9bb9af8be2099cdd1b305d6c7a5
         alias = jot
     domain_id = 34f6cfd7e8596ddc38693a50fe8ddfbc
url_project_id = d211924e6bb71da3ad9889517abc675e
         notes = new notes
        format = plain

Response

//jo.my/jot
Required parameters
parameterdescription
idIDID of the tracking pixel
Optional parameters
parameterdescription
conversion_idsARRAY_OF_IDSID of the associated conversion codes
notesSTRINGnotes for the tracking pixel
tagsARRAYcomma-separated list of tags for the tracking pixel
Return values
parameterdescription
aliassee i1/urls/shorten for details on returnd fields
domain_hostsee i1/urls/shorten for details on returnd fields
domain_idsee i1/urls/shorten for details on returnd fields
idID of the created tracking pixel
long_urlsee i1/urls/shorten for details on returnd fields
notessee i1/urls/shorten for details on returnd fields
project_idsee i1/urls/shorten for details on returnd fields
project_namesee i1/urls/shorten for details on returnd fields
short_urlsee i1/urls/shorten for details on returnd fields
tagssee i1/urls/shorten for details on returnd fields
url_conversions_numbernumber of associated conversion codes

/conversions/pixels/info

access: [READ]

This method returns information specified in a comma separated input called fields about a conversion.

Example 1 (json)

Request

https://joturl.com/a/i1/conversions/pixels/info?fields=id,short_url&id=58a5438e9afcf7889eb45ea1343eaaef

Query parameters

fields = id,short_url
    id = 58a5438e9afcf7889eb45ea1343eaaef

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": [
      {
        "id": "58a5438e9afcf7889eb45ea1343eaaef",
        "short_url": "http:\/\/jo.my\/336a1fad"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/conversions/pixels/info?fields=id,short_url&id=58a5438e9afcf7889eb45ea1343eaaef&format=xml

Query parameters

fields = id,short_url
    id = 58a5438e9afcf7889eb45ea1343eaaef
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <i0>
        <id>58a5438e9afcf7889eb45ea1343eaaef</id>  
        <short_url>http://jo.my/336a1fad</short_url>  
      </i0>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/conversions/pixels/info?fields=id,short_url&id=58a5438e9afcf7889eb45ea1343eaaef&format=txt

Query parameters

fields = id,short_url
    id = 58a5438e9afcf7889eb45ea1343eaaef
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_0_id=58a5438e9afcf7889eb45ea1343eaaef
result_data_0_short_url=http://jo.my/336a1fad

Example 4 (plain)

Request

https://joturl.com/a/i1/conversions/pixels/info?fields=id,short_url&id=58a5438e9afcf7889eb45ea1343eaaef&format=plain

Query parameters

fields = id,short_url
    id = 58a5438e9afcf7889eb45ea1343eaaef
format = plain

Response

http://jo.my/336a1fad
Required parameters
parameterdescription
fieldsARRAYcomma separated list of fields to return, see method i1/conversions/pixels/list for reference
idIDID of the tracking pixel whose information is required
Return values
parameterdescription
dataarray containing 1 item on success, the returned information depends on the fields parameter.

/conversions/pixels/list

access: [READ]

This method returns a list of tracking pixels.

Example 1 (json)

Request

https://joturl.com/a/i1/conversions/pixels/list?fields=id,short_url&url_project_id=ff91fa09465976591961426ee6558cd4

Query parameters

        fields = id,short_url
url_project_id = ff91fa09465976591961426ee6558cd4

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": [
      {
        "id": "ee68c61fa824080682df7ad6c3ff29dc",
        "short_url": "http:\/\/jo.my\/fab9f4c5"
      },
      {
        "id": "a84af8062958cf774370d18ab6af3ad4",
        "short_url": "http:\/\/jo.my\/3e7cf953"
      },
      {
        "id": "7f567d47a09c704bfcbba01e88b38cc8",
        "short_url": "http:\/\/jo.my\/eb1a1ad1"
      },
      {
        "id": "3491e295aea52d8ff7f380b57d48f05f",
        "short_url": "http:\/\/jo.my\/f321983e"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/conversions/pixels/list?fields=id,short_url&url_project_id=ff91fa09465976591961426ee6558cd4&format=xml

Query parameters

        fields = id,short_url
url_project_id = ff91fa09465976591961426ee6558cd4
        format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <i0>
        <id>ee68c61fa824080682df7ad6c3ff29dc</id>  
        <short_url>http://jo.my/fab9f4c5</short_url>  
      </i0>  
      <i1>
        <id>a84af8062958cf774370d18ab6af3ad4</id>  
        <short_url>http://jo.my/3e7cf953</short_url>  
      </i1>  
      <i2>
        <id>7f567d47a09c704bfcbba01e88b38cc8</id>  
        <short_url>http://jo.my/eb1a1ad1</short_url>  
      </i2>  
      <i3>
        <id>3491e295aea52d8ff7f380b57d48f05f</id>  
        <short_url>http://jo.my/f321983e</short_url>  
      </i3>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/conversions/pixels/list?fields=id,short_url&url_project_id=ff91fa09465976591961426ee6558cd4&format=txt

Query parameters

        fields = id,short_url
url_project_id = ff91fa09465976591961426ee6558cd4
        format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_0_id=ee68c61fa824080682df7ad6c3ff29dc
result_data_0_short_url=http://jo.my/fab9f4c5
result_data_1_id=a84af8062958cf774370d18ab6af3ad4
result_data_1_short_url=http://jo.my/3e7cf953
result_data_2_id=7f567d47a09c704bfcbba01e88b38cc8
result_data_2_short_url=http://jo.my/eb1a1ad1
result_data_3_id=3491e295aea52d8ff7f380b57d48f05f
result_data_3_short_url=http://jo.my/f321983e

Example 4 (plain)

Request

https://joturl.com/a/i1/conversions/pixels/list?fields=id,short_url&url_project_id=ff91fa09465976591961426ee6558cd4&format=plain

Query parameters

        fields = id,short_url
url_project_id = ff91fa09465976591961426ee6558cd4
        format = plain

Response

http://jo.my/fab9f4c5
http://jo.my/3e7cf953
http://jo.my/eb1a1ad1
http://jo.my/f321983e
Required parameters
parameterdescription
fieldsARRAYcomma separated list of fields to return, available fields: count, id, short_url, creation, url_tags, clicks, unique_visits, qrcodes_visits, conversions_visits, notes, alias
Optional parameters
parameterdescription
idIDID of the tracking pixel
lengthINTEGERextracts this number of items (maxmimum allowed: 100)
orderbyARRAYorders items by field, available fields: count, id, short_url, creation, url_tags, clicks, unique_visits, qrcodes_visits, conversions_visits, notes, alias
searchSTRINGfilters items to be extracted by searching them
sortSTRINGsorts items in ascending (ASC) or descending (DESC) order
startINTEGERstarts to extract items from this position
Return values
parameterdescription
dataarray containing information on the tracking pixels, the returned information depends on the fields parameter.

/conversions/settings

/conversions/settings/get

access: [READ]

This method returns global setting for conversions.

Example 1 (json)

Request

https://joturl.com/a/i1/conversions/settings/get

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "last_or_first_click": "last",
    "expiration_cookie": "30",
    "currency_id": "da899dd3e48fe4f186d27f3ade7b2fbe"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/conversions/settings/get?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <last_or_first_click>last</last_or_first_click>  
    <expiration_cookie>30</expiration_cookie>  
    <currency_id>da899dd3e48fe4f186d27f3ade7b2fbe</currency_id>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/conversions/settings/get?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_last_or_first_click=last
result_expiration_cookie=30
result_currency_id=da899dd3e48fe4f186d27f3ade7b2fbe

Example 4 (plain)

Request

https://joturl.com/a/i1/conversions/settings/get?format=plain

Query parameters

format = plain

Response

last
30
da899dd3e48fe4f186d27f3ade7b2fbe
Return values
parameterdescription
currency_idID of the currency to apply to conversions, see i1/currencies/list for details
expiration_cookieexpiration period (in days) for conversion cookies
last_or_first_clickthe click is assigned to the first or last click

/conversions/settings/property

access: [READ]

This method returns default values and properties for conversion settings.

Example 1 (json)

Request

https://joturl.com/a/i1/conversions/settings/property

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "default_last_or_first_click": "last",
    "default_expiration_cookie": "30",
    "default_currency_id": "644a4b356f74446f62613864764b3762725a343966673d3d",
    "default_clickbank_secret_key": "",
    "expiration_cookie_days": [
      1,
      7,
      30,
      60,
      90
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/conversions/settings/property?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <default_last_or_first_click>last</default_last_or_first_click>  
    <default_expiration_cookie>30</default_expiration_cookie>  
    <default_currency_id>644a4b356f74446f62613864764b3762725a343966673d3d</default_currency_id>  
    <default_clickbank_secret_key></default_clickbank_secret_key>  
    <expiration_cookie_days>
      <i0>1</i0>  
      <i1>7</i1>  
      <i2>30</i2>  
      <i3>60</i3>  
      <i4>90</i4>  
    </expiration_cookie_days>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/conversions/settings/property?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_default_last_or_first_click=last
result_default_expiration_cookie=30
result_default_currency_id=644a4b356f74446f62613864764b3762725a343966673d3d
result_default_clickbank_secret_key=
result_expiration_cookie_days_0=1
result_expiration_cookie_days_1=7
result_expiration_cookie_days_2=30
result_expiration_cookie_days_3=60
result_expiration_cookie_days_4=90

Example 4 (plain)

Request

https://joturl.com/a/i1/conversions/settings/property?format=plain

Query parameters

format = plain

Response

last
30
644a4b356f74446f62613864764b3762725a343966673d3d

1
7
30
60
90
Return values
parameterdescription
default_clickbank_secret_keydefault ClickBank secret key
default_currency_iddefault currency ID for the conversion, see i1/currencies/list for details
default_expiration_cookiedefault expiration (in days) for the conversion cookie
default_last_or_first_clickdefault behavior for the click assignment
expiration_cookie_dayslist of allowed expiration days

/conversions/settings/set

access: [WRITE]

This method sets global setting for conversions.

Example 1 (json)

Request

https://joturl.com/a/i1/conversions/settings/set?last_or_first_click=last&expiration_cookie=30¤cy_id=5f87701c74bcaf6562d7917a9a85beb3&clickbank_secret_key=2149F142079C03A3

Query parameters

 last_or_first_click = last
   expiration_cookie = 30
         currency_id = 5f87701c74bcaf6562d7917a9a85beb3
clickbank_secret_key = 2149F142079C03A3

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "updated": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/conversions/settings/set?last_or_first_click=last&expiration_cookie=30¤cy_id=5f87701c74bcaf6562d7917a9a85beb3&clickbank_secret_key=2149F142079C03A3&format=xml

Query parameters

 last_or_first_click = last
   expiration_cookie = 30
         currency_id = 5f87701c74bcaf6562d7917a9a85beb3
clickbank_secret_key = 2149F142079C03A3
              format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <updated>1</updated>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/conversions/settings/set?last_or_first_click=last&expiration_cookie=30¤cy_id=5f87701c74bcaf6562d7917a9a85beb3&clickbank_secret_key=2149F142079C03A3&format=txt

Query parameters

 last_or_first_click = last
   expiration_cookie = 30
         currency_id = 5f87701c74bcaf6562d7917a9a85beb3
clickbank_secret_key = 2149F142079C03A3
              format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_updated=1

Example 4 (plain)

Request

https://joturl.com/a/i1/conversions/settings/set?last_or_first_click=last&expiration_cookie=30¤cy_id=5f87701c74bcaf6562d7917a9a85beb3&clickbank_secret_key=2149F142079C03A3&format=plain

Query parameters

 last_or_first_click = last
   expiration_cookie = 30
         currency_id = 5f87701c74bcaf6562d7917a9a85beb3
clickbank_secret_key = 2149F142079C03A3
              format = plain

Response

1
Required parameters
parameterdescription
clickbank_secret_keySTRINGClickBank secret key
currency_idIDID of the currency to apply to conversions, see i1/currencies/list for details
expiration_cookieINTEGERexpiration period (in days) for conversion cookies, available values: 1, 7, 30, 60, 90
last_or_first_clickSTRINGassign a conversion to the first or last click made by the user on the tracking link/pixel
Return values
parameterdescription
updated1 on success, 0 otherwise

/ctas

/ctas/count

access: [READ]

This method returns the number of defined call to actions.

Example 1 (json)

Request

https://joturl.com/a/i1/ctas/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 2
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/ctas/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>2</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/ctas/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=2

Example 4 (plain)

Request

https://joturl.com/a/i1/ctas/count?format=plain

Query parameters

format = plain

Response

2
Optional parameters
parameterdescription
searchSTRINGfilters CTAs to be extracted by searching them
typesSTRINGcomma-separated list of types to filter CTAs, for available types see i1/ctas/property
Return values
parameterdescription
countnumber of (filtered) CTAs

/ctas/delete

access: [WRITE]

This method deletes a set of CTAs by using their IDs.

Example 1 (json)

Request

https://joturl.com/a/i1/ctas/delete?ids=6d531d5f3b2ec0262c0fb47323123d30,b4d48aa5ca39c19df007044e1d1046ce,5d070b169ec4a320ed1f25feca244313

Query parameters

ids = 6d531d5f3b2ec0262c0fb47323123d30,b4d48aa5ca39c19df007044e1d1046ce,5d070b169ec4a320ed1f25feca244313

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 3
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/ctas/delete?ids=6d531d5f3b2ec0262c0fb47323123d30,b4d48aa5ca39c19df007044e1d1046ce,5d070b169ec4a320ed1f25feca244313&format=xml

Query parameters

   ids = 6d531d5f3b2ec0262c0fb47323123d30,b4d48aa5ca39c19df007044e1d1046ce,5d070b169ec4a320ed1f25feca244313
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>3</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/ctas/delete?ids=6d531d5f3b2ec0262c0fb47323123d30,b4d48aa5ca39c19df007044e1d1046ce,5d070b169ec4a320ed1f25feca244313&format=txt

Query parameters

   ids = 6d531d5f3b2ec0262c0fb47323123d30,b4d48aa5ca39c19df007044e1d1046ce,5d070b169ec4a320ed1f25feca244313
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=3

Example 4 (plain)

Request

https://joturl.com/a/i1/ctas/delete?ids=6d531d5f3b2ec0262c0fb47323123d30,b4d48aa5ca39c19df007044e1d1046ce,5d070b169ec4a320ed1f25feca244313&format=plain

Query parameters

   ids = 6d531d5f3b2ec0262c0fb47323123d30,b4d48aa5ca39c19df007044e1d1046ce,5d070b169ec4a320ed1f25feca244313
format = plain

Response

3

Example 5 (json)

Request

https://joturl.com/a/i1/ctas/delete?ids=f149a58a86733b3fadba2a363146382d,a3f601128be86ed42be21ed87725ec51,6484ec951b59572af09f84f99e2187fb

Query parameters

ids = f149a58a86733b3fadba2a363146382d,a3f601128be86ed42be21ed87725ec51,6484ec951b59572af09f84f99e2187fb

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "ids": "f149a58a86733b3fadba2a363146382d,a3f601128be86ed42be21ed87725ec51",
    "deleted": 1
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/ctas/delete?ids=f149a58a86733b3fadba2a363146382d,a3f601128be86ed42be21ed87725ec51,6484ec951b59572af09f84f99e2187fb&format=xml

Query parameters

   ids = f149a58a86733b3fadba2a363146382d,a3f601128be86ed42be21ed87725ec51,6484ec951b59572af09f84f99e2187fb
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <ids>f149a58a86733b3fadba2a363146382d,a3f601128be86ed42be21ed87725ec51</ids>  
    <deleted>1</deleted>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/ctas/delete?ids=f149a58a86733b3fadba2a363146382d,a3f601128be86ed42be21ed87725ec51,6484ec951b59572af09f84f99e2187fb&format=txt

Query parameters

   ids = f149a58a86733b3fadba2a363146382d,a3f601128be86ed42be21ed87725ec51,6484ec951b59572af09f84f99e2187fb
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_ids=f149a58a86733b3fadba2a363146382d,a3f601128be86ed42be21ed87725ec51
result_deleted=1

Example 8 (plain)

Request

https://joturl.com/a/i1/ctas/delete?ids=f149a58a86733b3fadba2a363146382d,a3f601128be86ed42be21ed87725ec51,6484ec951b59572af09f84f99e2187fb&format=plain

Query parameters

   ids = f149a58a86733b3fadba2a363146382d,a3f601128be86ed42be21ed87725ec51,6484ec951b59572af09f84f99e2187fb
format = plain

Response

f149a58a86733b3fadba2a363146382d,a3f601128be86ed42be21ed87725ec51
1
Required parameters
parameterdescription
idsARRAY_OF_IDScomma separated list of CTA IDs to be deleted
Return values
parameterdescription
deletednumber of deleted CTAs
ids[OPTIONAL] list of CTA IDs whose delete has failed, this parameter is returned only when at least one delete error has occurred

/ctas/download

access: [READ]

This method returns data that is collected for a specific CTA. Only data collected in the last 90 days can be returned.

Example 1 (json)

Request

https://joturl.com/a/i1/ctas/download?id=f64178e09705ba938ac4fc93007067ce

Query parameters

id = f64178e09705ba938ac4fc93007067ce

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "headers": [
      "name",
      "age",
      "email"
    ],
    "lines": [
      [
        "John",
        "27",
        "john@example.com"
      ],
      [
        "Doo",
        "31",
        "doo@example.com"
      ]
    ],
    "extracted": 2,
    "skipped": 3,
    "count": 5,
    "next": ""
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/ctas/download?id=f64178e09705ba938ac4fc93007067ce&format=xml

Query parameters

    id = f64178e09705ba938ac4fc93007067ce
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <headers>
      <i0>name</i0>  
      <i1>age</i1>  
      <i2>email</i2>  
    </headers>  
    <lines>
      <i0>
        <i0>John</i0>  
        <i1>27</i1>  
        <i2>john@example.com</i2>  
      </i0>  
      <i1>
        <i0>Doo</i0>  
        <i1>31</i1>  
        <i2>doo@example.com</i2>  
      </i1>  
    </lines>  
    <extracted>2</extracted>  
    <skipped>3</skipped>  
    <count>5</count>  
    <next></next>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/ctas/download?id=f64178e09705ba938ac4fc93007067ce&format=txt

Query parameters

    id = f64178e09705ba938ac4fc93007067ce
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_headers_0=name
result_headers_1=age
result_headers_2=email
result_lines_0_0=John
result_lines_0_1=27
result_lines_0_2=john@example.com
result_lines_1_0=Doo
result_lines_1_1=31
result_lines_1_2=doo@example.com
result_extracted=2
result_skipped=3
result_count=5
result_next=

Example 4 (plain)

Request

https://joturl.com/a/i1/ctas/download?id=f64178e09705ba938ac4fc93007067ce&format=plain

Query parameters

    id = f64178e09705ba938ac4fc93007067ce
format = plain

Response

name
age
email
John
27
john@example.com
Doo
31
doo@example.com
2
3
5

Example 5 (json)

Request

https://joturl.com/a/i1/ctas/download?id=f64178e09705ba938ac4fc93007067ce&return_json=1

Query parameters

         id = f64178e09705ba938ac4fc93007067ce
return_json = 1

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": [
      {
        "name": "John",
        "age": "27",
        "email": "john@example.com"
      },
      {
        "name": "Doo",
        "age": "31",
        "email": "doo@example.com"
      }
    ],
    "extracted": 2,
    "skipped": 3,
    "count": 5,
    "next": ""
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/ctas/download?id=f64178e09705ba938ac4fc93007067ce&return_json=1&format=xml

Query parameters

         id = f64178e09705ba938ac4fc93007067ce
return_json = 1
     format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <i0>
        <name>John</name>  
        <age>27</age>  
        <email>john@example.com</email>  
      </i0>  
      <i1>
        <name>Doo</name>  
        <age>31</age>  
        <email>doo@example.com</email>  
      </i1>  
    </data>  
    <extracted>2</extracted>  
    <skipped>3</skipped>  
    <count>5</count>  
    <next></next>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/ctas/download?id=f64178e09705ba938ac4fc93007067ce&return_json=1&format=txt

Query parameters

         id = f64178e09705ba938ac4fc93007067ce
return_json = 1
     format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_0_name=John
result_data_0_age=27
result_data_0_email=john@example.com
result_data_1_name=Doo
result_data_1_age=31
result_data_1_email=doo@example.com
result_extracted=2
result_skipped=3
result_count=5
result_next=

Example 8 (plain)

Request

https://joturl.com/a/i1/ctas/download?id=f64178e09705ba938ac4fc93007067ce&return_json=1&format=plain

Query parameters

         id = f64178e09705ba938ac4fc93007067ce
return_json = 1
     format = plain

Response

John
27
john@example.com
Doo
31
doo@example.com
2
3
5

Required parameters
parameterdescription
idIDID of the call to action
Optional parameters
parameterdescription
from_dateDATEdate (inclusive) from which to start the export (default: 90 days before today)
lengthINTEGERnumber of items to return (default: 1000, max value: 1000)
return_jsonBOOLEANif 1 this method returns a JSON data fields instead of headers and lines fields (default: 0)
sampleBOOLEAN1 to return sample data, 0 otherwise (default: 0)
startINTEGERindex of the starting item to retrieve (default: 0)
to_dateDATEdate (inclusive) to finish the export (default: today)
Return values
parameterdescription
countmaximum number of items
data[OPTIONAL] alternative to headers and lines, returned if return_json=1
extractednumber of extracted items
headers[OPTIONAL] names of the corresponding information returned in lines, returned if return_json=0
lines[OPTIONAL] array containing information of the CTA data, returned if return_json=0
nextURL to be called in order to fetch the next page of the list
skippednumber of skipped items

/ctas/socialapps

/ctas/socialapps/add

access: [WRITE]

Add a new social app.

Example 1 (json)

Request

https://joturl.com/a/i1/ctas/socialapps/add?provider=facebook&name=my+custom+social+app&appid=4c20852c1265a5adfa4d3ef0c1fa1270&secret=46bdce73f6411dea0101c2f9bbc7fc25

Query parameters

provider = facebook
    name = my custom social app
   appid = 4c20852c1265a5adfa4d3ef0c1fa1270
  secret = 46bdce73f6411dea0101c2f9bbc7fc25

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "provider": "facebook",
    "id": "dac0cb2e056967d1c63a4a6e412d55c1",
    "name": "my custom social app",
    "appid": "4c20852c1265a5adfa4d3ef0c1fa1270"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/ctas/socialapps/add?provider=facebook&name=my+custom+social+app&appid=4c20852c1265a5adfa4d3ef0c1fa1270&secret=46bdce73f6411dea0101c2f9bbc7fc25&format=xml

Query parameters

provider = facebook
    name = my custom social app
   appid = 4c20852c1265a5adfa4d3ef0c1fa1270
  secret = 46bdce73f6411dea0101c2f9bbc7fc25
  format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <provider>facebook</provider>  
    <id>dac0cb2e056967d1c63a4a6e412d55c1</id>  
    <name>my custom social app</name>  
    <appid>4c20852c1265a5adfa4d3ef0c1fa1270</appid>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/ctas/socialapps/add?provider=facebook&name=my+custom+social+app&appid=4c20852c1265a5adfa4d3ef0c1fa1270&secret=46bdce73f6411dea0101c2f9bbc7fc25&format=txt

Query parameters

provider = facebook
    name = my custom social app
   appid = 4c20852c1265a5adfa4d3ef0c1fa1270
  secret = 46bdce73f6411dea0101c2f9bbc7fc25
  format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_provider=facebook
result_id=dac0cb2e056967d1c63a4a6e412d55c1
result_name=my custom social app
result_appid=4c20852c1265a5adfa4d3ef0c1fa1270

Example 4 (plain)

Request

https://joturl.com/a/i1/ctas/socialapps/add?provider=facebook&name=my+custom+social+app&appid=4c20852c1265a5adfa4d3ef0c1fa1270&secret=46bdce73f6411dea0101c2f9bbc7fc25&format=plain

Query parameters

provider = facebook
    name = my custom social app
   appid = 4c20852c1265a5adfa4d3ef0c1fa1270
  secret = 46bdce73f6411dea0101c2f9bbc7fc25
  format = plain

Response

facebook
dac0cb2e056967d1c63a4a6e412d55c1
my custom social app
4c20852c1265a5adfa4d3ef0c1fa1270
Required parameters
parameterdescriptionmax length
appidSTRINGsocial app ID/Key/Client ID255
nameSTRINGname of the social app255
providerSTRINGname of the provider of the app, available providers: google, facebook, twitter, linkedin, amazon, microsoftgraph50
secretSTRINGsocial app secret255
Return values
parameterdescription
appidsocial app ID/Key/Client ID
idID of the social app
namename of the social app
providername of the provider of the app, available providers: google, facebook, twitter, linkedin, amazon, microsoftgraph

/ctas/socialapps/count

access: [READ]

This method returns the number of defined social apps.

Example 1 (json)

Request

https://joturl.com/a/i1/ctas/socialapps/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 5
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/ctas/socialapps/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>5</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/ctas/socialapps/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=5

Example 4 (plain)

Request

https://joturl.com/a/i1/ctas/socialapps/count?format=plain

Query parameters

format = plain

Response

5

Example 5 (json)

Request

https://joturl.com/a/i1/ctas/socialapps/count?search=test

Query parameters

search = test

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 3
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/ctas/socialapps/count?search=test&format=xml

Query parameters

search = test
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>3</count>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/ctas/socialapps/count?search=test&format=txt

Query parameters

search = test
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=3

Example 8 (plain)

Request

https://joturl.com/a/i1/ctas/socialapps/count?search=test&format=plain

Query parameters

search = test
format = plain

Response

3
Optional parameters
parameterdescriptionmax length
providerSTRINGname of the provider of the app, available providers: google, facebook, twitter, linkedin, amazon, microsoftgraph50
searchSTRINGcount items by searching them
Return values
parameterdescription
countnumber of social apps the user has access to (filtered by search if passed)

/ctas/socialapps/delete

access: [WRITE]

Delete a social app.

Example 1 (json)

Request

https://joturl.com/a/i1/ctas/socialapps/delete?ids=9a882c25a00963ddc52c76eb3cc8369e,c1c081593509ff660f30ab8d7b6a2fd7

Query parameters

ids = 9a882c25a00963ddc52c76eb3cc8369e,c1c081593509ff660f30ab8d7b6a2fd7

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 2
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/ctas/socialapps/delete?ids=9a882c25a00963ddc52c76eb3cc8369e,c1c081593509ff660f30ab8d7b6a2fd7&format=xml

Query parameters

   ids = 9a882c25a00963ddc52c76eb3cc8369e,c1c081593509ff660f30ab8d7b6a2fd7
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>2</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/ctas/socialapps/delete?ids=9a882c25a00963ddc52c76eb3cc8369e,c1c081593509ff660f30ab8d7b6a2fd7&format=txt

Query parameters

   ids = 9a882c25a00963ddc52c76eb3cc8369e,c1c081593509ff660f30ab8d7b6a2fd7
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=2

Example 4 (plain)

Request

https://joturl.com/a/i1/ctas/socialapps/delete?ids=9a882c25a00963ddc52c76eb3cc8369e,c1c081593509ff660f30ab8d7b6a2fd7&format=plain

Query parameters

   ids = 9a882c25a00963ddc52c76eb3cc8369e,c1c081593509ff660f30ab8d7b6a2fd7
format = plain

Response

2

Example 5 (json)

Request

https://joturl.com/a/i1/ctas/socialapps/delete?ids=44518ce03a475d5f738d820917f4219d,ab5db45cf9c8366600c13fd2451bf754,06f8fea9ffe1482dd4af21d39076c08e

Query parameters

ids = 44518ce03a475d5f738d820917f4219d,ab5db45cf9c8366600c13fd2451bf754,06f8fea9ffe1482dd4af21d39076c08e

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "ids": "44518ce03a475d5f738d820917f4219d,ab5db45cf9c8366600c13fd2451bf754",
    "deleted": 1
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/ctas/socialapps/delete?ids=44518ce03a475d5f738d820917f4219d,ab5db45cf9c8366600c13fd2451bf754,06f8fea9ffe1482dd4af21d39076c08e&format=xml

Query parameters

   ids = 44518ce03a475d5f738d820917f4219d,ab5db45cf9c8366600c13fd2451bf754,06f8fea9ffe1482dd4af21d39076c08e
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <ids>44518ce03a475d5f738d820917f4219d,ab5db45cf9c8366600c13fd2451bf754</ids>  
    <deleted>1</deleted>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/ctas/socialapps/delete?ids=44518ce03a475d5f738d820917f4219d,ab5db45cf9c8366600c13fd2451bf754,06f8fea9ffe1482dd4af21d39076c08e&format=txt

Query parameters

   ids = 44518ce03a475d5f738d820917f4219d,ab5db45cf9c8366600c13fd2451bf754,06f8fea9ffe1482dd4af21d39076c08e
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_ids=44518ce03a475d5f738d820917f4219d,ab5db45cf9c8366600c13fd2451bf754
result_deleted=1

Example 8 (plain)

Request

https://joturl.com/a/i1/ctas/socialapps/delete?ids=44518ce03a475d5f738d820917f4219d,ab5db45cf9c8366600c13fd2451bf754,06f8fea9ffe1482dd4af21d39076c08e&format=plain

Query parameters

   ids = 44518ce03a475d5f738d820917f4219d,ab5db45cf9c8366600c13fd2451bf754,06f8fea9ffe1482dd4af21d39076c08e
format = plain

Response

44518ce03a475d5f738d820917f4219d,ab5db45cf9c8366600c13fd2451bf754
1
Required parameters
parameterdescription
idsARRAY_OF_IDScomma separated list of social app IDs to be deleted
Optional parameters
parameterdescription
confirmBOOLEAN1 to force the cancellation of social apps even if in use (default: 0)
Return values
parameterdescription
deletednumber of deleted social apps
ids[OPTIONAL] list of social app IDs whose delete has failed, this parameter is returned only when at least one delete error has occurred

/ctas/socialapps/edit

access: [WRITE]

Edit a social app.

Example 1 (json)

Request

https://joturl.com/a/i1/ctas/socialapps/edit?provider=facebook&name=social+app+name&appid=1968d615385f48bd3defa6b41dbca7d9

Query parameters

provider = facebook
    name = social app name
   appid = 1968d615385f48bd3defa6b41dbca7d9

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "7dd0657c23fc2a3249dbb400e633802b",
    "provider": "facebook",
    "name": "social app name",
    "appid": "1968d615385f48bd3defa6b41dbca7d9"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/ctas/socialapps/edit?provider=facebook&name=social+app+name&appid=1968d615385f48bd3defa6b41dbca7d9&format=xml

Query parameters

provider = facebook
    name = social app name
   appid = 1968d615385f48bd3defa6b41dbca7d9
  format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>7dd0657c23fc2a3249dbb400e633802b</id>  
    <provider>facebook</provider>  
    <name>social app name</name>  
    <appid>1968d615385f48bd3defa6b41dbca7d9</appid>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/ctas/socialapps/edit?provider=facebook&name=social+app+name&appid=1968d615385f48bd3defa6b41dbca7d9&format=txt

Query parameters

provider = facebook
    name = social app name
   appid = 1968d615385f48bd3defa6b41dbca7d9
  format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=7dd0657c23fc2a3249dbb400e633802b
result_provider=facebook
result_name=social app name
result_appid=1968d615385f48bd3defa6b41dbca7d9

Example 4 (plain)

Request

https://joturl.com/a/i1/ctas/socialapps/edit?provider=facebook&name=social+app+name&appid=1968d615385f48bd3defa6b41dbca7d9&format=plain

Query parameters

provider = facebook
    name = social app name
   appid = 1968d615385f48bd3defa6b41dbca7d9
  format = plain

Response

7dd0657c23fc2a3249dbb400e633802b
facebook
social app name
1968d615385f48bd3defa6b41dbca7d9
Required parameters
parameterdescription
idIDID of the social app
Optional parameters
parameterdescriptionmax length
appidSTRINGsocial app ID/Key/Client ID255
nameSTRINGname of the social app255
providerSTRINGname of the provider of the app, available providers: google, facebook, twitter, linkedin, amazon, microsoftgraph50
secretSTRINGsocial app secret255
Return values
parameterdescription
appidsocial app ID/Key/Client ID
idID of the social app
namename of the social app
providername of the provider of the app, available providers: google, facebook, twitter, linkedin, amazon, microsoftgraph

/ctas/socialapps/info

access: [READ]

This method returns information on a social app.

Example 1 (json)

Request

https://joturl.com/a/i1/ctas/socialapps/info?id=80bdb703228d2e29baf4a8245f989cbc

Query parameters

id = 80bdb703228d2e29baf4a8245f989cbc

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "80bdb703228d2e29baf4a8245f989cbc",
    "provider": "facebook",
    "name": "this is my app name",
    "appid": "fc86bcddfaa4900956b54e4b91e4bc8d"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/ctas/socialapps/info?id=80bdb703228d2e29baf4a8245f989cbc&format=xml

Query parameters

    id = 80bdb703228d2e29baf4a8245f989cbc
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>80bdb703228d2e29baf4a8245f989cbc</id>  
    <provider>facebook</provider>  
    <name>this is my app name</name>  
    <appid>fc86bcddfaa4900956b54e4b91e4bc8d</appid>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/ctas/socialapps/info?id=80bdb703228d2e29baf4a8245f989cbc&format=txt

Query parameters

    id = 80bdb703228d2e29baf4a8245f989cbc
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=80bdb703228d2e29baf4a8245f989cbc
result_provider=facebook
result_name=this is my app name
result_appid=fc86bcddfaa4900956b54e4b91e4bc8d

Example 4 (plain)

Request

https://joturl.com/a/i1/ctas/socialapps/info?id=80bdb703228d2e29baf4a8245f989cbc&format=plain

Query parameters

    id = 80bdb703228d2e29baf4a8245f989cbc
format = plain

Response

80bdb703228d2e29baf4a8245f989cbc
facebook
this is my app name
fc86bcddfaa4900956b54e4b91e4bc8d
Required parameters
parameterdescription
idIDID of the social app
Return values
parameterdescription
appidsocial app ID/Key/Client ID
idID of the social app
namename of the social app
providername of the provider of the app, available providers: google, facebook, twitter, linkedin, amazon, microsoftgraph

/ctas/socialapps/list

access: [READ]

This method returns a list of social apps.

Example 1 (json)

Request

https://joturl.com/a/i1/ctas/socialapps/list

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 1,
    "data": {
      "id": "38c9c6060a8c8fd035374355afc48d95",
      "provider": "facebook",
      "name": "this is my app name",
      "appid": "f6b4d8dfe9f953635d6d4753bbac9d22"
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/ctas/socialapps/list?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>1</count>  
    <data>
      <id>38c9c6060a8c8fd035374355afc48d95</id>  
      <provider>facebook</provider>  
      <name>this is my app name</name>  
      <appid>f6b4d8dfe9f953635d6d4753bbac9d22</appid>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/ctas/socialapps/list?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=1
result_data_id=38c9c6060a8c8fd035374355afc48d95
result_data_provider=facebook
result_data_name=this is my app name
result_data_appid=f6b4d8dfe9f953635d6d4753bbac9d22

Example 4 (plain)

Request

https://joturl.com/a/i1/ctas/socialapps/list?format=plain

Query parameters

format = plain

Response

1
38c9c6060a8c8fd035374355afc48d95
facebook
this is my app name
f6b4d8dfe9f953635d6d4753bbac9d22
Optional parameters
parameterdescriptionmax length
lengthINTEGERextracts this number of items (maxmimum allowed: 100)
orderbyARRAYorders items by field, available fields: start, length, search, orderby, sort, provider, format, callback
providerSTRINGfilter social apps by provider, available providers: google, facebook, twitter, linkedin, amazon, microsoftgraph50
searchSTRINGfilters items to be extracted by searching them
sortSTRINGsorts items in ascending (ASC) or descending (DESC) order
startINTEGERstarts to extract items from this position
Return values
parameterdescription
counttotal number of social apps
dataarray containing information on social apps the user has access to

/ctas/socialapps/property

access: [READ]

Returns the supported social app providers.

Example 1 (json)

Request

https://joturl.com/a/i1/ctas/socialapps/property

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": {
      "providers": [
        "amazon",
        "facebook",
        "google",
        "linkedin",
        "microsoftgraph",
        "twitter"
      ]
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/ctas/socialapps/property?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <providers>
        <i0>amazon</i0>  
        <i1>facebook</i1>  
        <i2>google</i2>  
        <i3>linkedin</i3>  
        <i4>microsoftgraph</i4>  
        <i5>twitter</i5>  
      </providers>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/ctas/socialapps/property?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_providers_0=amazon
result_data_providers_1=facebook
result_data_providers_2=google
result_data_providers_3=linkedin
result_data_providers_4=microsoftgraph
result_data_providers_5=twitter

Example 4 (plain)

Request

https://joturl.com/a/i1/ctas/socialapps/property?format=plain

Query parameters

format = plain

Response

amazon
facebook
google
linkedin
microsoftgraph
twitter
Return values
parameterdescription
datalist of supported social apps

/ctas/urls

/ctas/urls/count

access: [READ]

This method returns the number of user's urls related to a call to action.

Example 1 (json)

Request

https://joturl.com/a/i1/ctas/urls/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 2
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/ctas/urls/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>2</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/ctas/urls/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=2

Example 4 (plain)

Request

https://joturl.com/a/i1/ctas/urls/count?format=plain

Query parameters

format = plain

Response

2
Required parameters
parameterdescription
cta_idIDID of the CTA
Optional parameters
parameterdescription
searchSTRINGfilters tracking pixels to be extracted by searching them
Return values
parameterdescription
countnumber of (filtered) tracking pixels

/ctas/urls/list

access: [READ]

This method returns a list of user's urls data related to a call to action.

Example 1 (json)

Request

https://joturl.com/a/i1/ctas/urls/list?id=209f892864b8ea68d52b926488a8a337&fields=count,id,url_url

Query parameters

    id = 209f892864b8ea68d52b926488a8a337
fields = count,id,url_url

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 3,
    "data": [
      {
        "id": "b6436a307ac263542d4bdec4af403051",
        "url_url": "29a8d56c"
      },
      {
        "id": "e59b645abf1bf912662135fdb77466d4",
        "url_url": "71b1bad"
      },
      {
        "id": "37b34fe4140f16dd272489608e30f5f8",
        "url_url": "36f99a2f"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/ctas/urls/list?id=209f892864b8ea68d52b926488a8a337&fields=count,id,url_url&format=xml

Query parameters

    id = 209f892864b8ea68d52b926488a8a337
fields = count,id,url_url
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>3</count>  
    <data>
      <i0>
        <id>b6436a307ac263542d4bdec4af403051</id>  
        <url_url>29a8d56c</url_url>  
      </i0>  
      <i1>
        <id>e59b645abf1bf912662135fdb77466d4</id>  
        <url_url>71b1bad</url_url>  
      </i1>  
      <i2>
        <id>37b34fe4140f16dd272489608e30f5f8</id>  
        <url_url>36f99a2f</url_url>  
      </i2>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/ctas/urls/list?id=209f892864b8ea68d52b926488a8a337&fields=count,id,url_url&format=txt

Query parameters

    id = 209f892864b8ea68d52b926488a8a337
fields = count,id,url_url
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=3
result_data_0_id=b6436a307ac263542d4bdec4af403051
result_data_0_url_url=29a8d56c
result_data_1_id=e59b645abf1bf912662135fdb77466d4
result_data_1_url_url=71b1bad
result_data_2_id=37b34fe4140f16dd272489608e30f5f8
result_data_2_url_url=36f99a2f

Example 4 (plain)

Request

https://joturl.com/a/i1/ctas/urls/list?id=209f892864b8ea68d52b926488a8a337&fields=count,id,url_url&format=plain

Query parameters

    id = 209f892864b8ea68d52b926488a8a337
fields = count,id,url_url
format = plain

Response

3
b6436a307ac263542d4bdec4af403051
29a8d56c
e59b645abf1bf912662135fdb77466d4
71b1bad
37b34fe4140f16dd272489608e30f5f8
36f99a2f
Required parameters
parameterdescription
cta_idIDID of the CTA
fieldsARRAYcomma-separated list of fields to return, available fields: count, id, url_url, short_url, url_creation, url, has_preview, domain_extended_name, domain_id, project_name, project_is_default, project_id
Optional parameters
parameterdescription
lengthINTEGERextracts this number of tracking links (maxmimum allowed: 100)
orderbyARRAYorders tracking links by field, available fields: id, url_url, short_url, url_creation, url, has_preview, domain_extended_name, domain_id, project_name, project_is_default, project_id
searchSTRINGfilters tracking links to be extracted by searching them
sortSTRINGsorts tracking links in ascending (ASC) or descending (DESC) order
startINTEGERstarts to extract tracking links from this position
Return values
parameterdescription
count[OPTIONAL] total number of tracking links, returned only if count is passed in fields
dataarray containing information on the tracking links, the returned information depends on the fields parameter.

/ctas/webhooks

/ctas/webhooks/info

access: [READ]

This method return information on a webhook.

Example 1 (json)

Request

https://joturl.com/a/i1/ctas/webhooks/info?id=54df76730aa54fc99f5442c82a4e175b

Query parameters

id = 54df76730aa54fc99f5442c82a4e175b

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "54df76730aa54fc99f5442c82a4e175b",
    "url": "https:\/\/my.custom.webhook\/",
    "type": "custom",
    "info": [],
    "notes": ""
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/ctas/webhooks/info?id=54df76730aa54fc99f5442c82a4e175b&format=xml

Query parameters

    id = 54df76730aa54fc99f5442c82a4e175b
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>54df76730aa54fc99f5442c82a4e175b</id>  
    <url>https://my.custom.webhook/</url>  
    <type>custom</type>  
    <info>

    </info>  
    <notes></notes>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/ctas/webhooks/info?id=54df76730aa54fc99f5442c82a4e175b&format=txt

Query parameters

    id = 54df76730aa54fc99f5442c82a4e175b
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=54df76730aa54fc99f5442c82a4e175b
result_url=https://my.custom.webhook/
result_type=custom
result_info=
result_notes=

Example 4 (plain)

Request

https://joturl.com/a/i1/ctas/webhooks/info?id=54df76730aa54fc99f5442c82a4e175b&format=plain

Query parameters

    id = 54df76730aa54fc99f5442c82a4e175b
format = plain

Response

54df76730aa54fc99f5442c82a4e175b
https://my.custom.webhook/
custom


Required parameters
parameterdescription
idIDID of the CTA from which to remove the webhook
Return values
parameterdescription
idecho back of the id input parameter
infoextended info of the webhook
notesnotes for the webhook
typewebhook type, see i1/ctas/webhooks/property for details
urlURL of the webhook

/ctas/webhooks/property

access: [READ]

Return available webhook types and their parameters.

Example 1 (json)

Request

https://joturl.com/a/i1/ctas/webhooks/property?types=custom,zapier,mailerlite

Query parameters

types = custom,zapier,mailerlite

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": {
      "custom": {
        "name": "Custom webhook",
        "private": 0,
        "url_required": 1,
        "info": {
          "home": "https:\/\/joturl.zendesk.com\/hc\/en-us\/articles\/360012882199",
          "logo": "data:image\/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB2ZXJzaW9uPSIxLjEiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8cGF0aCBkPSJtMjU2IDcuMzZjLTY1LjI1OSAwLTExOC40IDUzLjE0MS0xMTguNCAxMTguNCAwIDM4Ljk0MyAxOS4zMzMgNzMuMTIxIDQ4LjQ3IDk0LjcybC01OC40NiA5Ni41N2MtMC40NjItMC4xMzktMC45NzEtMC4yMzEtMS40OC0wLjM3LTEyLjIxLTMuMjg0LTI0LjkyOS0xLjQ4LTM1Ljg5IDQuODEtMjIuNjE2IDEzLjA4OS0zMC40MzIgNDIuMTM0LTE3LjM5IDY0Ljc1IDguNzQxIDE1LjE3IDI0LjY5NyAyMy42OCA0MS4wNyAyMy42OCA4LjA0NyAwIDE2LjIzNC0xLjk4OSAyMy42OC02LjI5IDEwLjk2MS02LjMzNiAxOC45MTYtMTYuNjUgMjIuMi0yOC44NnMxLjUyNi0yNC45MjktNC44MS0zNS44OWMtMS45ODktMy40MjItNC43MTgtNi40NzUtNy40LTkuMjVsNzAuNjctMTE2LjE4LTEwLjM2LTUuOTJjLTI3Ljg4OS0xNi40NjUtNDYuNjItNDYuOTQ0LTQ2LjYyLTgxLjc3IDAtNTIuNDQ4IDQyLjI3My05NC43MiA5NC43Mi05NC43MnM5NC43MiA0Mi4yNzIgOTQuNzIgOTQuNzJjMCA5Ljc1OS0xLjM0MSAxOC45MTYtNC4wNyAyNy43NWwyMi41NyA3LjAzYzMuNDIyLTExLjA1NCA1LjE4LTIyLjY2MiA1LjE4LTM0Ljc4IDAtNjUuMjU5LTUzLjE0MS0xMTguNC0xMTguNC0xMTguNHptMCA3MS4wNGMtMjYuMTMxIDAtNDcuMzYgMjEuMjI5LTQ3LjM2IDQ3LjM2czIxLjIyOSA0Ny4zNiA0Ny4zNiA0Ny4zNmMzLjkzMSAwIDcuODE2LTAuNTU1IDExLjQ3LTEuNDhsNTYuOTggMTAzLjIzIDUuNTUgMTAuMzYgMTAuNzMtNS41NWMxMy41NTEtNy40OTMgMjguOTA2LTExLjg0IDQ1LjUxLTExLjg0IDUyLjQ0OCAwIDk0LjcyIDQyLjI3MiA5NC43MiA5NC43MnMtNDIuMjczIDk0LjcyLTk0LjcyIDk0LjcyYy0yNS41NzYgMC00OC43OTQtMTAuMjIxLTY1Ljg2LTI2LjY0bC0xNi4yOCAxNy4wMmMyMS4yNzUgMjAuNDg5IDUwLjMyIDMzLjMgODIuMTQgMzMuMyA2NS4yNTkgMCAxMTguNC01My4xNDEgMTE4LjQtMTE4LjRzLTUzLjE0MS0xMTguNC0xMTguNC0xMTguNGMtMTYuNDE5IDAtMzEuNjM1IDQuMzAxLTQ1Ljg4IDEwLjM2bC01Mi4xNy05NC4zNWM5LjI1LTguNjQ5IDE1LjE3LTIwLjc2NiAxNS4xNy0zNC40MSAwLTI2LjEzMS0yMS4yMjktNDcuMzYtNDcuMzYtNDcuMzZ6bS0xNzAuOTQgMTY5LjA5Yy01MS41NjkgMTIuODU3LTg5LjU0IDU5LjcwOS04OS41NCAxMTUuMDcgMCA2NS4yNTkgNTMuMTQxIDExOC40IDExOC40IDExOC40IDYxLjA1IDAgMTA5Ljk0LTQ3LjEyOSAxMTYuMTgtMTA2LjU2aDExMC42M2M1LjI3MiAyMC4zOTYgMjMuNDk1IDM1LjUyIDQ1LjUxIDM1LjUyIDI2LjEzMSAwIDQ3LjM2LTIxLjIyOSA0Ny4zNi00Ny4zNnMtMjEuMjI5LTQ3LjM2LTQ3LjM2LTQ3LjM2Yy0yMi4wMTUgMC00MC4yMzggMTUuMTI0LTQ1LjUxIDM1LjUyaC0xMzIuMDl2MTEuODRjMCA1Mi40NDgtNDIuMjczIDk0LjcyLTk0LjcyIDk0Ljcycy05NC43Mi00Mi4yNzItOTQuNzItOTQuNzJjMC00NC40OTIgMzAuNjE4LTgxLjQ5MiA3MS43OC05MS43NnoiLz4KPC9zdmc+Cg=="
        },
        "parameters": [
          {
            "name": "fields",
            "type": "json",
            "maxlength": 2000,
            "description": "couples key\/values",
            "mandatory": 0,
            "example": "{\"source\":\"joturl\",\"test\":1}"
          }
        ]
      },
      "mailerlite": {
        "name": "MailerLite",
        "private": 0,
        "url_required": 0,
        "info": {
          "home": "https:\/\/www.mailerlite.com\/",
          "logo": "https:\/\/www.mailerlite.com\/assets\/logo-color.png"
        },
        "parameters": [
          {
            "name": "apikey",
            "type": "string",
            "maxlength": 500,
            "description": "MailerLite API key",
            "documentation": "https:\/\/help.mailerlite.com\/article\/show\/35040-where-can-i-find-the-api-key",
            "mandatory": 1,
            "example": "fdfbd6b38a05da4b0624583518b3e54c"
          },
          {
            "name": "group",
            "type": "string",
            "maxlength": 500,
            "description": "GroupID of the MailerLite group",
            "documentation": "https:\/\/app.mailerlite.com\/subscribe\/api",
            "mandatory": 1,
            "example": "238214594"
          },
          {
            "name": "fields",
            "type": "json",
            "maxlength": 2000,
            "description": "couples key\/values",
            "mandatory": 0,
            "example": "{\"source\":\"joturl\",\"test\":1}"
          }
        ]
      },
      "zapier": {
        "name": "Zapier",
        "private": 1,
        "url_required": 0,
        "info": {
          "home": "https:\/\/zapier.com\/",
          "logo": "https:\/\/cdn.zapier.com\/zapier\/images\/logos\/zapier-logo.png"
        },
        "parameters": []
      }
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/ctas/webhooks/property?types=custom,zapier,mailerlite&format=xml

Query parameters

 types = custom,zapier,mailerlite
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <custom>
        <name>Custom webhook</name>  
        <private>0</private>  
        <url_required>1</url_required>  
        <info>
          <home>https://joturl.zendesk.com/hc/en-us/articles/360012882199</home>  
          <logo>data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB2ZXJzaW9uPSIxLjEiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8cGF0aCBkPSJtMjU2IDcuMzZjLTY1LjI1OSAwLTExOC40IDUzLjE0MS0xMTguNCAxMTguNCAwIDM4Ljk0MyAxOS4zMzMgNzMuMTIxIDQ4LjQ3IDk0LjcybC01OC40NiA5Ni41N2MtMC40NjItMC4xMzktMC45NzEtMC4yMzEtMS40OC0wLjM3LTEyLjIxLTMuMjg0LTI0LjkyOS0xLjQ4LTM1Ljg5IDQuODEtMjIuNjE2IDEzLjA4OS0zMC40MzIgNDIuMTM0LTE3LjM5IDY0Ljc1IDguNzQxIDE1LjE3IDI0LjY5NyAyMy42OCA0MS4wNyAyMy42OCA4LjA0NyAwIDE2LjIzNC0xLjk4OSAyMy42OC02LjI5IDEwLjk2MS02LjMzNiAxOC45MTYtMTYuNjUgMjIuMi0yOC44NnMxLjUyNi0yNC45MjktNC44MS0zNS44OWMtMS45ODktMy40MjItNC43MTgtNi40NzUtNy40LTkuMjVsNzAuNjctMTE2LjE4LTEwLjM2LTUuOTJjLTI3Ljg4OS0xNi40NjUtNDYuNjItNDYuOTQ0LTQ2LjYyLTgxLjc3IDAtNTIuNDQ4IDQyLjI3My05NC43MiA5NC43Mi05NC43MnM5NC43MiA0Mi4yNzIgOTQuNzIgOTQuNzJjMCA5Ljc1OS0xLjM0MSAxOC45MTYtNC4wNyAyNy43NWwyMi41NyA3LjAzYzMuNDIyLTExLjA1NCA1LjE4LTIyLjY2MiA1LjE4LTM0Ljc4IDAtNjUuMjU5LTUzLjE0MS0xMTguNC0xMTguNC0xMTguNHptMCA3MS4wNGMtMjYuMTMxIDAtNDcuMzYgMjEuMjI5LTQ3LjM2IDQ3LjM2czIxLjIyOSA0Ny4zNiA0Ny4zNiA0Ny4zNmMzLjkzMSAwIDcuODE2LTAuNTU1IDExLjQ3LTEuNDhsNTYuOTggMTAzLjIzIDUuNTUgMTAuMzYgMTAuNzMtNS41NWMxMy41NTEtNy40OTMgMjguOTA2LTExLjg0IDQ1LjUxLTExLjg0IDUyLjQ0OCAwIDk0LjcyIDQyLjI3MiA5NC43MiA5NC43MnMtNDIuMjczIDk0LjcyLTk0LjcyIDk0LjcyYy0yNS41NzYgMC00OC43OTQtMTAuMjIxLTY1Ljg2LTI2LjY0bC0xNi4yOCAxNy4wMmMyMS4yNzUgMjAuNDg5IDUwLjMyIDMzLjMgODIuMTQgMzMuMyA2NS4yNTkgMCAxMTguNC01My4xNDEgMTE4LjQtMTE4LjRzLTUzLjE0MS0xMTguNC0xMTguNC0xMTguNGMtMTYuNDE5IDAtMzEuNjM1IDQuMzAxLTQ1Ljg4IDEwLjM2bC01Mi4xNy05NC4zNWM5LjI1LTguNjQ5IDE1LjE3LTIwLjc2NiAxNS4xNy0zNC40MSAwLTI2LjEzMS0yMS4yMjktNDcuMzYtNDcuMzYtNDcuMzZ6bS0xNzAuOTQgMTY5LjA5Yy01MS41NjkgMTIuODU3LTg5LjU0IDU5LjcwOS04OS41NCAxMTUuMDcgMCA2NS4yNTkgNTMuMTQxIDExOC40IDExOC40IDExOC40IDYxLjA1IDAgMTA5Ljk0LTQ3LjEyOSAxMTYuMTgtMTA2LjU2aDExMC42M2M1LjI3MiAyMC4zOTYgMjMuNDk1IDM1LjUyIDQ1LjUxIDM1LjUyIDI2LjEzMSAwIDQ3LjM2LTIxLjIyOSA0Ny4zNi00Ny4zNnMtMjEuMjI5LTQ3LjM2LTQ3LjM2LTQ3LjM2Yy0yMi4wMTUgMC00MC4yMzggMTUuMTI0LTQ1LjUxIDM1LjUyaC0xMzIuMDl2MTEuODRjMCA1Mi40NDgtNDIuMjczIDk0LjcyLTk0LjcyIDk0Ljcycy05NC43Mi00Mi4yNzItOTQuNzItOTQuNzJjMC00NC40OTIgMzAuNjE4LTgxLjQ5MiA3MS43OC05MS43NnoiLz4KPC9zdmc+Cg==</logo>  
        </info>  
        <parameters>
          <i0>
            <name>fields</name>  
            <type>json</type>  
            <maxlength>2000</maxlength>  
            <description>couples key/values</description>  
            <mandatory>0</mandatory>  
            <example>{"source":"joturl","test":1}</example>  
          </i0>  
        </parameters>  
      </custom>  
      <mailerlite>
        <name>MailerLite</name>  
        <private>0</private>  
        <url_required>0</url_required>  
        <info>
          <home>https://www.mailerlite.com/</home>  
          <logo>https://www.mailerlite.com/assets/logo-color.png</logo>  
        </info>  
        <parameters>
          <i0>
            <name>apikey</name>  
            <type>string</type>  
            <maxlength>500</maxlength>  
            <description>MailerLite API key</description>  
            <documentation>https://help.mailerlite.com/article/show/35040-where-can-i-find-the-api-key</documentation>  
            <mandatory>1</mandatory>  
            <example>fdfbd6b38a05da4b0624583518b3e54c</example>  
          </i0>  
          <i1>
            <name>group</name>  
            <type>string</type>  
            <maxlength>500</maxlength>  
            <description>GroupID of the MailerLite group</description>  
            <documentation>https://app.mailerlite.com/subscribe/api</documentation>  
            <mandatory>1</mandatory>  
            <example>238214594</example>  
          </i1>  
          <i2>
            <name>fields</name>  
            <type>json</type>  
            <maxlength>2000</maxlength>  
            <description>couples key/values</description>  
            <mandatory>0</mandatory>  
            <example>{"source":"joturl","test":1}</example>  
          </i2>  
        </parameters>  
      </mailerlite>  
      <zapier>
        <name>Zapier</name>  
        <private>1</private>  
        <url_required>0</url_required>  
        <info>
          <home>https://zapier.com/</home>  
          <logo>https://cdn.zapier.com/zapier/images/logos/zapier-logo.png</logo>  
        </info>  
        <parameters>

        </parameters>  
      </zapier>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/ctas/webhooks/property?types=custom,zapier,mailerlite&format=txt

Query parameters

 types = custom,zapier,mailerlite
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_custom_name=Custom webhook
result_data_custom_private=0
result_data_custom_url_required=1
result_data_custom_info_home=https://joturl.zendesk.com/hc/en-us/articles/360012882199
result_data_custom_info_logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB2ZXJzaW9uPSIxLjEiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8cGF0aCBkPSJtMjU2IDcuMzZjLTY1LjI1OSAwLTExOC40IDUzLjE0MS0xMTguNCAxMTguNCAwIDM4Ljk0MyAxOS4zMzMgNzMuMTIxIDQ4LjQ3IDk0LjcybC01OC40NiA5Ni41N2MtMC40NjItMC4xMzktMC45NzEtMC4yMzEtMS40OC0wLjM3LTEyLjIxLTMuMjg0LTI0LjkyOS0xLjQ4LTM1Ljg5IDQuODEtMjIuNjE2IDEzLjA4OS0zMC40MzIgNDIuMTM0LTE3LjM5IDY0Ljc1IDguNzQxIDE1LjE3IDI0LjY5NyAyMy42OCA0MS4wNyAyMy42OCA4LjA0NyAwIDE2LjIzNC0xLjk4OSAyMy42OC02LjI5IDEwLjk2MS02LjMzNiAxOC45MTYtMTYuNjUgMjIuMi0yOC44NnMxLjUyNi0yNC45MjktNC44MS0zNS44OWMtMS45ODktMy40MjItNC43MTgtNi40NzUtNy40LTkuMjVsNzAuNjctMTE2LjE4LTEwLjM2LTUuOTJjLTI3Ljg4OS0xNi40NjUtNDYuNjItNDYuOTQ0LTQ2LjYyLTgxLjc3IDAtNTIuNDQ4IDQyLjI3My05NC43MiA5NC43Mi05NC43MnM5NC43MiA0Mi4yNzIgOTQuNzIgOTQuNzJjMCA5Ljc1OS0xLjM0MSAxOC45MTYtNC4wNyAyNy43NWwyMi41NyA3LjAzYzMuNDIyLTExLjA1NCA1LjE4LTIyLjY2MiA1LjE4LTM0Ljc4IDAtNjUuMjU5LTUzLjE0MS0xMTguNC0xMTguNC0xMTguNHptMCA3MS4wNGMtMjYuMTMxIDAtNDcuMzYgMjEuMjI5LTQ3LjM2IDQ3LjM2czIxLjIyOSA0Ny4zNiA0Ny4zNiA0Ny4zNmMzLjkzMSAwIDcuODE2LTAuNTU1IDExLjQ3LTEuNDhsNTYuOTggMTAzLjIzIDUuNTUgMTAuMzYgMTAuNzMtNS41NWMxMy41NTEtNy40OTMgMjguOTA2LTExLjg0IDQ1LjUxLTExLjg0IDUyLjQ0OCAwIDk0LjcyIDQyLjI3MiA5NC43MiA5NC43MnMtNDIuMjczIDk0LjcyLTk0LjcyIDk0LjcyYy0yNS41NzYgMC00OC43OTQtMTAuMjIxLTY1Ljg2LTI2LjY0bC0xNi4yOCAxNy4wMmMyMS4yNzUgMjAuNDg5IDUwLjMyIDMzLjMgODIuMTQgMzMuMyA2NS4yNTkgMCAxMTguNC01My4xNDEgMTE4LjQtMTE4LjRzLTUzLjE0MS0xMTguNC0xMTguNC0xMTguNGMtMTYuNDE5IDAtMzEuNjM1IDQuMzAxLTQ1Ljg4IDEwLjM2bC01Mi4xNy05NC4zNWM5LjI1LTguNjQ5IDE1LjE3LTIwLjc2NiAxNS4xNy0zNC40MSAwLTI2LjEzMS0yMS4yMjktNDcuMzYtNDcuMzYtNDcuMzZ6bS0xNzAuOTQgMTY5LjA5Yy01MS41NjkgMTIuODU3LTg5LjU0IDU5LjcwOS04OS41NCAxMTUuMDcgMCA2NS4yNTkgNTMuMTQxIDExOC40IDExOC40IDExOC40IDYxLjA1IDAgMTA5Ljk0LTQ3LjEyOSAxMTYuMTgtMTA2LjU2aDExMC42M2M1LjI3MiAyMC4zOTYgMjMuNDk1IDM1LjUyIDQ1LjUxIDM1LjUyIDI2LjEzMSAwIDQ3LjM2LTIxLjIyOSA0Ny4zNi00Ny4zNnMtMjEuMjI5LTQ3LjM2LTQ3LjM2LTQ3LjM2Yy0yMi4wMTUgMC00MC4yMzggMTUuMTI0LTQ1LjUxIDM1LjUyaC0xMzIuMDl2MTEuODRjMCA1Mi40NDgtNDIuMjczIDk0LjcyLTk0LjcyIDk0Ljcycy05NC43Mi00Mi4yNzItOTQuNzItOTQuNzJjMC00NC40OTIgMzAuNjE4LTgxLjQ5MiA3MS43OC05MS43NnoiLz4KPC9zdmc+Cg==
result_data_custom_parameters_0_name=fields
result_data_custom_parameters_0_type=json
result_data_custom_parameters_0_maxlength=2000
result_data_custom_parameters_0_description=couples key/values
result_data_custom_parameters_0_mandatory=0
result_data_custom_parameters_0_example={"source":"joturl","test":1}
result_data_mailerlite_name=MailerLite
result_data_mailerlite_private=0
result_data_mailerlite_url_required=0
result_data_mailerlite_info_home=https://www.mailerlite.com/
result_data_mailerlite_info_logo=https://www.mailerlite.com/assets/logo-color.png
result_data_mailerlite_parameters_0_name=apikey
result_data_mailerlite_parameters_0_type=string
result_data_mailerlite_parameters_0_maxlength=500
result_data_mailerlite_parameters_0_description=MailerLite API key
result_data_mailerlite_parameters_0_documentation=https://help.mailerlite.com/article/show/35040-where-can-i-find-the-api-key
result_data_mailerlite_parameters_0_mandatory=1
result_data_mailerlite_parameters_0_example=fdfbd6b38a05da4b0624583518b3e54c
result_data_mailerlite_parameters_1_name=group
result_data_mailerlite_parameters_1_type=string
result_data_mailerlite_parameters_1_maxlength=500
result_data_mailerlite_parameters_1_description=GroupID of the MailerLite group
result_data_mailerlite_parameters_1_documentation=https://app.mailerlite.com/subscribe/api
result_data_mailerlite_parameters_1_mandatory=1
result_data_mailerlite_parameters_1_example=238214594
result_data_mailerlite_parameters_2_name=fields
result_data_mailerlite_parameters_2_type=json
result_data_mailerlite_parameters_2_maxlength=2000
result_data_mailerlite_parameters_2_description=couples key/values
result_data_mailerlite_parameters_2_mandatory=0
result_data_mailerlite_parameters_2_example={"source":"joturl","test":1}
result_data_zapier_name=Zapier
result_data_zapier_private=1
result_data_zapier_url_required=0
result_data_zapier_info_home=https://zapier.com/
result_data_zapier_info_logo=https://cdn.zapier.com/zapier/images/logos/zapier-logo.png
result_data_zapier_parameters=

Example 4 (plain)

Request

https://joturl.com/a/i1/ctas/webhooks/property?types=custom,zapier,mailerlite&format=plain

Query parameters

 types = custom,zapier,mailerlite
format = plain

Response

Custom webhook
0
1
https://joturl.zendesk.com/hc/en-us/articles/360012882199
data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB2ZXJzaW9uPSIxLjEiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8cGF0aCBkPSJtMjU2IDcuMzZjLTY1LjI1OSAwLTExOC40IDUzLjE0MS0xMTguNCAxMTguNCAwIDM4Ljk0MyAxOS4zMzMgNzMuMTIxIDQ4LjQ3IDk0LjcybC01OC40NiA5Ni41N2MtMC40NjItMC4xMzktMC45NzEtMC4yMzEtMS40OC0wLjM3LTEyLjIxLTMuMjg0LTI0LjkyOS0xLjQ4LTM1Ljg5IDQuODEtMjIuNjE2IDEzLjA4OS0zMC40MzIgNDIuMTM0LTE3LjM5IDY0Ljc1IDguNzQxIDE1LjE3IDI0LjY5NyAyMy42OCA0MS4wNyAyMy42OCA4LjA0NyAwIDE2LjIzNC0xLjk4OSAyMy42OC02LjI5IDEwLjk2MS02LjMzNiAxOC45MTYtMTYuNjUgMjIuMi0yOC44NnMxLjUyNi0yNC45MjktNC44MS0zNS44OWMtMS45ODktMy40MjItNC43MTgtNi40NzUtNy40LTkuMjVsNzAuNjctMTE2LjE4LTEwLjM2LTUuOTJjLTI3Ljg4OS0xNi40NjUtNDYuNjItNDYuOTQ0LTQ2LjYyLTgxLjc3IDAtNTIuNDQ4IDQyLjI3My05NC43MiA5NC43Mi05NC43MnM5NC43MiA0Mi4yNzIgOTQuNzIgOTQuNzJjMCA5Ljc1OS0xLjM0MSAxOC45MTYtNC4wNyAyNy43NWwyMi41NyA3LjAzYzMuNDIyLTExLjA1NCA1LjE4LTIyLjY2MiA1LjE4LTM0Ljc4IDAtNjUuMjU5LTUzLjE0MS0xMTguNC0xMTguNC0xMTguNHptMCA3MS4wNGMtMjYuMTMxIDAtNDcuMzYgMjEuMjI5LTQ3LjM2IDQ3LjM2czIxLjIyOSA0Ny4zNiA0Ny4zNiA0Ny4zNmMzLjkzMSAwIDcuODE2LTAuNTU1IDExLjQ3LTEuNDhsNTYuOTggMTAzLjIzIDUuNTUgMTAuMzYgMTAuNzMtNS41NWMxMy41NTEtNy40OTMgMjguOTA2LTExLjg0IDQ1LjUxLTExLjg0IDUyLjQ0OCAwIDk0LjcyIDQyLjI3MiA5NC43MiA5NC43MnMtNDIuMjczIDk0LjcyLTk0LjcyIDk0LjcyYy0yNS41NzYgMC00OC43OTQtMTAuMjIxLTY1Ljg2LTI2LjY0bC0xNi4yOCAxNy4wMmMyMS4yNzUgMjAuNDg5IDUwLjMyIDMzLjMgODIuMTQgMzMuMyA2NS4yNTkgMCAxMTguNC01My4xNDEgMTE4LjQtMTE4LjRzLTUzLjE0MS0xMTguNC0xMTguNC0xMTguNGMtMTYuNDE5IDAtMzEuNjM1IDQuMzAxLTQ1Ljg4IDEwLjM2bC01Mi4xNy05NC4zNWM5LjI1LTguNjQ5IDE1LjE3LTIwLjc2NiAxNS4xNy0zNC40MSAwLTI2LjEzMS0yMS4yMjktNDcuMzYtNDcuMzYtNDcuMzZ6bS0xNzAuOTQgMTY5LjA5Yy01MS41NjkgMTIuODU3LTg5LjU0IDU5LjcwOS04OS41NCAxMTUuMDcgMCA2NS4yNTkgNTMuMTQxIDExOC40IDExOC40IDExOC40IDYxLjA1IDAgMTA5Ljk0LTQ3LjEyOSAxMTYuMTgtMTA2LjU2aDExMC42M2M1LjI3MiAyMC4zOTYgMjMuNDk1IDM1LjUyIDQ1LjUxIDM1LjUyIDI2LjEzMSAwIDQ3LjM2LTIxLjIyOSA0Ny4zNi00Ny4zNnMtMjEuMjI5LTQ3LjM2LTQ3LjM2LTQ3LjM2Yy0yMi4wMTUgMC00MC4yMzggMTUuMTI0LTQ1LjUxIDM1LjUyaC0xMzIuMDl2MTEuODRjMCA1Mi40NDgtNDIuMjczIDk0LjcyLTk0LjcyIDk0Ljcycy05NC43Mi00Mi4yNzItOTQuNzItOTQuNzJjMC00NC40OTIgMzAuNjE4LTgxLjQ5MiA3MS43OC05MS43NnoiLz4KPC9zdmc+Cg==
fields
json
2000
couples key/values
0
{"source":"joturl","test":1}
MailerLite
0
0
https://www.mailerlite.com/
https://www.mailerlite.com/assets/logo-color.png
apikey
string
500
MailerLite API key
https://help.mailerlite.com/article/show/35040-where-can-i-find-the-api-key
1
fdfbd6b38a05da4b0624583518b3e54c
group
string
500
GroupID of the MailerLite group
https://app.mailerlite.com/subscribe/api
1
238214594
fields
json
2000
couples key/values
0
{"source":"joturl","test":1}
Zapier
1
0
https://zapier.com/
https://cdn.zapier.com/zapier/images/logos/zapier-logo.png

Optional parameters
parameterdescription
typesSTRINGcomma-separated list of webhook types to be returned, if empty all types are returned, available types: activecampaign, custom, drift, getresponse, hubspot, mailchimp, mailerlite, mailjet, mautic, moosend, sendinblue, zapier
Return values
parameterdescription
dataarray containing information on webhook parameters by type

/ctas/webhooks/subscribe

access: [WRITE]

This method add a webhook subscription to a CTA.

Example 1 (json)

Request

https://joturl.com/a/i1/ctas/webhooks/subscribe?id=2ca6b8924e7a2649fe3b8161793e3418&url=https%3A%2F%2Fjoturl.com%2F

Query parameters

 id = 2ca6b8924e7a2649fe3b8161793e3418
url = https://joturl.com/

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "added": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/ctas/webhooks/subscribe?id=2ca6b8924e7a2649fe3b8161793e3418&url=https%3A%2F%2Fjoturl.com%2F&format=xml

Query parameters

    id = 2ca6b8924e7a2649fe3b8161793e3418
   url = https://joturl.com/
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <added>1</added>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/ctas/webhooks/subscribe?id=2ca6b8924e7a2649fe3b8161793e3418&url=https%3A%2F%2Fjoturl.com%2F&format=txt

Query parameters

    id = 2ca6b8924e7a2649fe3b8161793e3418
   url = https://joturl.com/
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_added=1

Example 4 (plain)

Request

https://joturl.com/a/i1/ctas/webhooks/subscribe?id=2ca6b8924e7a2649fe3b8161793e3418&url=https%3A%2F%2Fjoturl.com%2F&format=plain

Query parameters

    id = 2ca6b8924e7a2649fe3b8161793e3418
   url = https://joturl.com/
format = plain

Response

1
Required parameters
parameterdescription
idIDID of the CTA to which to add the webhook
typeSTRINGwebhook type, allowed types: activecampaign, custom, drift, getresponse, hubspot, mailchimp, mailerlite, mailjet, mautic, moosend, sendinblue, zapier
Optional parameters
parameterdescriptionmax length
infoJSONinfo to be used with the webhook (e.g., an API key), see below for details
notesSTRINGnotes for the webhook4000
unsubscribeBOOLEAN1 to unsubscribe from the current webhook (if any) and subscribe to the new one
urlSTRINGURL of the webhook, required for types: custom, zapier4000
Return values
parameterdescription
added1 on success, 0 otherwise

/ctas/webhooks/test

access: [WRITE]

This endpoint sends test data to a CTA webhook.

Example 1 (json)

Request

https://joturl.com/a/i1/ctas/webhooks/test?id=13bda637d520e8c6858286554742bb54

Query parameters

id = 13bda637d520e8c6858286554742bb54

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "ok": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/ctas/webhooks/test?id=13bda637d520e8c6858286554742bb54&format=xml

Query parameters

    id = 13bda637d520e8c6858286554742bb54
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <ok>1</ok>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/ctas/webhooks/test?id=13bda637d520e8c6858286554742bb54&format=txt

Query parameters

    id = 13bda637d520e8c6858286554742bb54
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_ok=1

Example 4 (plain)

Request

https://joturl.com/a/i1/ctas/webhooks/test?id=13bda637d520e8c6858286554742bb54&format=plain

Query parameters

    id = 13bda637d520e8c6858286554742bb54
format = plain

Response

1
Required parameters
parameterdescription
idIDID of the CTA associated with the webhook
Return values
parameterdescription
ok1 on success, otherwise an error is returned

/ctas/webhooks/unsubscribe

access: [WRITE]

This method removes a webhook subscription to a CTA.

Example 1 (json)

Request

https://joturl.com/a/i1/ctas/webhooks/unsubscribe?id=c7ef3e4e4119cda455399f4b681bde7e

Query parameters

id = c7ef3e4e4119cda455399f4b681bde7e

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "removed": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/ctas/webhooks/unsubscribe?id=c7ef3e4e4119cda455399f4b681bde7e&format=xml

Query parameters

    id = c7ef3e4e4119cda455399f4b681bde7e
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <removed>1</removed>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/ctas/webhooks/unsubscribe?id=c7ef3e4e4119cda455399f4b681bde7e&format=txt

Query parameters

    id = c7ef3e4e4119cda455399f4b681bde7e
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_removed=1

Example 4 (plain)

Request

https://joturl.com/a/i1/ctas/webhooks/unsubscribe?id=c7ef3e4e4119cda455399f4b681bde7e&format=plain

Query parameters

    id = c7ef3e4e4119cda455399f4b681bde7e
format = plain

Response

1
Required parameters
parameterdescription
idIDID of the CTA from which to remove the webhook
Return values
parameterdescription
removed1 on success, 0 otherwise

/currencies

/currencies/info

access: [READ]

This method returns a list of available currencies.

Example 1 (json)

Request

https://joturl.com/a/i1/currencies/info?id=279cee8f659e37762db1efd77b3aac93

Query parameters

id = 279cee8f659e37762db1efd77b3aac93

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": [
      {
        "id": "279cee8f659e37762db1efd77b3aac93",
        "code": "EUR",
        "sign": "€"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/currencies/info?id=279cee8f659e37762db1efd77b3aac93&format=xml

Query parameters

    id = 279cee8f659e37762db1efd77b3aac93
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <i0>
        <id>279cee8f659e37762db1efd77b3aac93</id>  
        <code>EUR</code>  
        <sign><[CDATA[&euro;]]></sign>  
      </i0>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/currencies/info?id=279cee8f659e37762db1efd77b3aac93&format=txt

Query parameters

    id = 279cee8f659e37762db1efd77b3aac93
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_0_id=279cee8f659e37762db1efd77b3aac93
result_data_0_code=EUR
result_data_0_sign=&euro;

Example 4 (plain)

Request

https://joturl.com/a/i1/currencies/info?id=279cee8f659e37762db1efd77b3aac93&format=plain

Query parameters

    id = 279cee8f659e37762db1efd77b3aac93
format = plain

Response

279cee8f659e37762db1efd77b3aac93
EUR
&euro;
Required parameters
parameterdescription
idIDID of the currency
Return values
parameterdescription
datainformation on the specified currency

/currencies/list

access: [READ]

This method returns a list of available currencies.

Example 1 (json)

Request

https://joturl.com/a/i1/currencies/list

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": [
      {
        "id": "e2ead91cd7a68eb79577c33bae5bf64a",
        "code": "EUR",
        "sign": "€"
      },
      {
        "id": "ae85747201fb0e9a15efe250191f6131",
        "code": "USD",
        "sign": "$"
      },
      {
        "id": "5003b994ff348352fa7bac3117140180",
        "code": "GBP",
        "sign": "£"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/currencies/list?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <i0>
        <id>e2ead91cd7a68eb79577c33bae5bf64a</id>  
        <code>EUR</code>  
        <sign><[CDATA[&euro;]]></sign>  
      </i0>  
      <i1>
        <id>ae85747201fb0e9a15efe250191f6131</id>  
        <code>USD</code>  
        <sign>$</sign>  
      </i1>  
      <i2>
        <id>5003b994ff348352fa7bac3117140180</id>  
        <code>GBP</code>  
        <sign><[CDATA[&pound;]]></sign>  
      </i2>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/currencies/list?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_0_id=e2ead91cd7a68eb79577c33bae5bf64a
result_data_0_code=EUR
result_data_0_sign=&euro;
result_data_1_id=ae85747201fb0e9a15efe250191f6131
result_data_1_code=USD
result_data_1_sign=$
result_data_2_id=5003b994ff348352fa7bac3117140180
result_data_2_code=GBP
result_data_2_sign=&pound;

Example 4 (plain)

Request

https://joturl.com/a/i1/currencies/list?format=plain

Query parameters

format = plain

Response

e2ead91cd7a68eb79577c33bae5bf64a
EUR
&euro;
ae85747201fb0e9a15efe250191f6131
USD
$
5003b994ff348352fa7bac3117140180
GBP
&pound;
Return values
parameterdescription
datainformation on the specified currency

/domains

/domains/add

access: [WRITE]

Add a domain for the logged user.

Example 1 (json)

Request

https://joturl.com/a/i1/domains/add?id=1234567890abcdef&force_https=0&host=domain.ext&nickname=my+domain+nickname&redirect_url=https%3A%2F%2Fredirect.users.to%2F&favicon_url=https%3A%2F%2Fpath.to%2Ffav%2Ficon&deeplink_id=&domain_domains_deeplink_name=&input=name_of_the_form_field_that_contains_image_data

Query parameters

                          id = 1234567890abcdef
                 force_https = 0
                        host = domain.ext
                    nickname = my domain nickname
                redirect_url = https://redirect.users.to/
                 favicon_url = https://path.to/fav/icon
                 deeplink_id = 
domain_domains_deeplink_name = 
                       input = name_of_the_form_field_that_contains_image_data

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "1234567890abcdef",
    "force_https": "0",
    "host": "domain.ext",
    "nickname": "my domain nickname",
    "redirect_url": "https:\/\/redirect.users.to\/",
    "favicon_url": "https:\/\/path.to\/fav\/icon",
    "logo": "data:image\/gif;base64,R0lGODlhAQABAIAAAAAAAP\/\/\/yH5BAEAAAAALAAAAAABAAEAAAIBRAA7",
    "deeplink_id": "",
    "domain_domains_deeplink_name": ""
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/add?id=1234567890abcdef&force_https=0&host=domain.ext&nickname=my+domain+nickname&redirect_url=https%3A%2F%2Fredirect.users.to%2F&favicon_url=https%3A%2F%2Fpath.to%2Ffav%2Ficon&deeplink_id=&domain_domains_deeplink_name=&input=name_of_the_form_field_that_contains_image_data&format=xml

Query parameters

                          id = 1234567890abcdef
                 force_https = 0
                        host = domain.ext
                    nickname = my domain nickname
                redirect_url = https://redirect.users.to/
                 favicon_url = https://path.to/fav/icon
                 deeplink_id = 
domain_domains_deeplink_name = 
                       input = name_of_the_form_field_that_contains_image_data
                      format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>1234567890abcdef</id>  
    <force_https>0</force_https>  
    <host>domain.ext</host>  
    <nickname>my domain nickname</nickname>  
    <redirect_url>https://redirect.users.to/</redirect_url>  
    <favicon_url>https://path.to/fav/icon</favicon_url>  
    <logo>data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7</logo>  
    <deeplink_id></deeplink_id>  
    <domain_domains_deeplink_name></domain_domains_deeplink_name>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/add?id=1234567890abcdef&force_https=0&host=domain.ext&nickname=my+domain+nickname&redirect_url=https%3A%2F%2Fredirect.users.to%2F&favicon_url=https%3A%2F%2Fpath.to%2Ffav%2Ficon&deeplink_id=&domain_domains_deeplink_name=&input=name_of_the_form_field_that_contains_image_data&format=txt

Query parameters

                          id = 1234567890abcdef
                 force_https = 0
                        host = domain.ext
                    nickname = my domain nickname
                redirect_url = https://redirect.users.to/
                 favicon_url = https://path.to/fav/icon
                 deeplink_id = 
domain_domains_deeplink_name = 
                       input = name_of_the_form_field_that_contains_image_data
                      format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=1234567890abcdef
result_force_https=0
result_host=domain.ext
result_nickname=my domain nickname
result_redirect_url=https://redirect.users.to/
result_favicon_url=https://path.to/fav/icon
result_logo=data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7
result_deeplink_id=
result_domain_domains_deeplink_name=

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/add?id=1234567890abcdef&force_https=0&host=domain.ext&nickname=my+domain+nickname&redirect_url=https%3A%2F%2Fredirect.users.to%2F&favicon_url=https%3A%2F%2Fpath.to%2Ffav%2Ficon&deeplink_id=&domain_domains_deeplink_name=&input=name_of_the_form_field_that_contains_image_data&format=plain

Query parameters

                          id = 1234567890abcdef
                 force_https = 0
                        host = domain.ext
                    nickname = my domain nickname
                redirect_url = https://redirect.users.to/
                 favicon_url = https://path.to/fav/icon
                 deeplink_id = 
domain_domains_deeplink_name = 
                       input = name_of_the_form_field_that_contains_image_data
                      format = plain

Response

1234567890abcdef
0
domain.ext
my domain nickname
https://redirect.users.to/
https://path.to/fav/icon
data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7


Required parameters
parameterdescriptionmax length
hostSTRINGdomain to add (e.g., domain.ext)850
Optional parameters
parameterdescriptionmax length
deeplink_idIDID of the deep link configuration
favicon_urlSTRINGthe default favicon URL for the branded domain (to avoid securiy issues it must be HTTPS)4000
forceBOOLEAN1 to disable security checks, 0 otherwise. This parameter is ignored if force_https = 1
force_httpsBOOLEAN1 to force HTTPS on HTTP requests, 0 otherwise (this flag takes effect only if a valid SSL certificate is associated with the domain)
inputSTRINGname of the HTML form field that contains image data for the logo (max dimensions 120px x 50px, max size 150kB), see notes for details255
nicknameSTRINGthe domain nickname50
redirect_urlSTRINGthe default destination URL where to redirect when a user types the domain without any alias (or an invalid alias)4000
robots_txtSTRINGthe robots.txt content to serve for the domain, when robots_txt = :NONE: requests to robots.txt will return a 404 error, if empty the following robots.txt will be served:
user-agent: *
disallow: /
4000

NOTES: The parameter input contains the name of the field of the HTML form that is used to send logo data to this method. Form must have enctype = "multipart/form-data" and method = "post".

<form 
    action="/a/i1/domains/add" 
    method="post" 
    enctype="multipart/form-data">

    <input name="input" value="logo" type="hidden"/>

    [other form fields]

    <input name="logo" type="file"/>    

</form>
Return values
parameterdescription
deeplink_idID of the deep link configuration
deeplink_nameNA
favicon_urldefault favicon URL
force_https1 if the HTTPS is forced for the domain, 0 otherwise (this flag takes effect only if a valid SSL certificate is associated with the domain)
hostthe domain that was just added
idID of the added domain
logodefault logo for the domain (base64 encoded)
nicknamethe domain nickname
redirect_urldefault redirect URL
robots_txtthe robots.txt content to serve for the domain

/domains/certificates

/domains/certificates/acmes

/domains/certificates/acmes/domains/cert

access: [WRITE]

This method creates or renews an SSL certificate for a domain.

Example 1 (json)

Request

https://joturl.com/a/i1/domains/certificates/acmes/domains/cert?domain_id=541b0ded5df8b14bab47f3e180637855

Query parameters

domain_id = 541b0ded5df8b14bab47f3e180637855

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "created": 1,
    "private_key": "-----BEGIN PRIVATE KEY-----[BASE64-ENCODED INFO]-----END PRIVATE KEY-----",
    "csr": "-----BEGIN CERTIFICATE REQUEST-----[BASE64-ENCODED INFO]-----END CERTIFICATE REQUEST-----",
    "cert": "-----BEGIN CERTIFICATE-----[BASE64-ENCODED INFO]-----END CERTIFICATE-----",
    "cert_fingerprint": "9B5BDE73B0B3604B66688BB1092B0BB0DE2FD264",
    "cert_valid_from": "2025-06-27T16:52:39",
    "cert_valid_to": "2025-09-25T16:52:39",
    "intermediate": "-----BEGIN CERTIFICATE-----[BASE64-ENCODED INFO]-----END CERTIFICATE-----"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/certificates/acmes/domains/cert?domain_id=541b0ded5df8b14bab47f3e180637855&format=xml

Query parameters

domain_id = 541b0ded5df8b14bab47f3e180637855
   format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <created>1</created>  
    <private_key>-----BEGIN PRIVATE KEY-----[BASE64-ENCODED INFO]-----END PRIVATE KEY-----</private_key>  
    <csr>-----BEGIN CERTIFICATE REQUEST-----[BASE64-ENCODED INFO]-----END CERTIFICATE REQUEST-----</csr>  
    <cert>-----BEGIN CERTIFICATE-----[BASE64-ENCODED INFO]-----END CERTIFICATE-----</cert>  
    <cert_fingerprint>9B5BDE73B0B3604B66688BB1092B0BB0DE2FD264</cert_fingerprint>  
    <cert_valid_from>2025-06-27T16:52:39</cert_valid_from>  
    <cert_valid_to>2025-09-25T16:52:39</cert_valid_to>  
    <intermediate>-----BEGIN CERTIFICATE-----[BASE64-ENCODED INFO]-----END CERTIFICATE-----</intermediate>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/certificates/acmes/domains/cert?domain_id=541b0ded5df8b14bab47f3e180637855&format=txt

Query parameters

domain_id = 541b0ded5df8b14bab47f3e180637855
   format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_created=1
result_private_key=-----BEGIN PRIVATE KEY-----[BASE64-ENCODED INFO]-----END PRIVATE KEY-----
result_csr=-----BEGIN CERTIFICATE REQUEST-----[BASE64-ENCODED INFO]-----END CERTIFICATE REQUEST-----
result_cert=-----BEGIN CERTIFICATE-----[BASE64-ENCODED INFO]-----END CERTIFICATE-----
result_cert_fingerprint=9B5BDE73B0B3604B66688BB1092B0BB0DE2FD264
result_cert_valid_from=2025-06-27T16:52:39
result_cert_valid_to=2025-09-25T16:52:39
result_intermediate=-----BEGIN CERTIFICATE-----[BASE64-ENCODED INFO]-----END CERTIFICATE-----

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/certificates/acmes/domains/cert?domain_id=541b0ded5df8b14bab47f3e180637855&format=plain

Query parameters

domain_id = 541b0ded5df8b14bab47f3e180637855
   format = plain

Response

1
-----BEGIN PRIVATE KEY-----[BASE64-ENCODED INFO]-----END PRIVATE KEY-----
-----BEGIN CERTIFICATE REQUEST-----[BASE64-ENCODED INFO]-----END CERTIFICATE REQUEST-----
-----BEGIN CERTIFICATE-----[BASE64-ENCODED INFO]-----END CERTIFICATE-----
9B5BDE73B0B3604B66688BB1092B0BB0DE2FD264
2025-06-27T16:52:39
2025-09-25T16:52:39
-----BEGIN CERTIFICATE-----[BASE64-ENCODED INFO]-----END CERTIFICATE-----
Required parameters
parameterdescription
domain_idIDID of the domain for which the SSL certificate is asked
Return values
parameterdescription
certdomain SSL certificate (PEM format)
cert_fingerprintfingerprint of the SSL certificate
cert_valid_fromSSL certificate is valid from this date
cert_valid_toSSL certificate is valid up to this date, usually the certificate expires 90 days after the cert_valid_from date; see <a href="https://letsencrypt.org/docs/faq/">the Let's Encrypt FAQ</a> for details
created1 on success, 0 otherwise
csrcertificate signing request (CSR) for the doamin (PEM format)
intermediatedomain intermediate certificate(s) (PEM format)
private_keydomain private key (PEM format)
/domains/certificates/acmes/domains/install

access: [WRITE]

This method installs an SSL certificate for a domain.

Example 1 (json)

Request

https://joturl.com/a/i1/domains/certificates/acmes/domains/install?domain_id=b061db32401a049d4e7ecb35bd7ab741

Query parameters

domain_id = b061db32401a049d4e7ecb35bd7ab741

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "installed": 1,
    "host": "jo.my",
    "cn": "jo.my",
    "certificate_domain_id": "6e666877484257716e798888484252472b645a4a49518d8d",
    "domains": "jo.my, www.jo.my",
    "fingerprint": "6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265",
    "id": "69785a4b2f7676744c5a4759642f67524561584b58778d8d",
    "valid_from": "2018-01-23 14:58:37",
    "valid_to": "2018-04-23 14:58:37",
    "issuer": "JotUrl S.r.l."
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/certificates/acmes/domains/install?domain_id=b061db32401a049d4e7ecb35bd7ab741&format=xml

Query parameters

domain_id = b061db32401a049d4e7ecb35bd7ab741
   format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <installed>1</installed>  
    <host>jo.my</host>  
    <cn>jo.my</cn>  
    <certificate_domain_id>6e666877484257716e798888484252472b645a4a49518d8d</certificate_domain_id>  
    <domains>jo.my, www.jo.my</domains>  
    <fingerprint>6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265</fingerprint>  
    <id>69785a4b2f7676744c5a4759642f67524561584b58778d8d</id>  
    <valid_from>2018-01-23 14:58:37</valid_from>  
    <valid_to>2018-04-23 14:58:37</valid_to>  
    <issuer>JotUrl S.r.l.</issuer>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/certificates/acmes/domains/install?domain_id=b061db32401a049d4e7ecb35bd7ab741&format=txt

Query parameters

domain_id = b061db32401a049d4e7ecb35bd7ab741
   format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_installed=1
result_host=jo.my
result_cn=jo.my
result_certificate_domain_id=6e666877484257716e798888484252472b645a4a49518d8d
result_domains=jo.my, www.jo.my
result_fingerprint=6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265
result_id=69785a4b2f7676744c5a4759642f67524561584b58778d8d
result_valid_from=2018-01-23 14:58:37
result_valid_to=2018-04-23 14:58:37
result_issuer=JotUrl S.r.l.

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/certificates/acmes/domains/install?domain_id=b061db32401a049d4e7ecb35bd7ab741&format=plain

Query parameters

domain_id = b061db32401a049d4e7ecb35bd7ab741
   format = plain

Response

1
jo.my
jo.my
6e666877484257716e798888484252472b645a4a49518d8d
jo.my, www.jo.my
6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265
69785a4b2f7676744c5a4759642f67524561584b58778d8d
2018-01-23 14:58:37
2018-04-23 14:58:37
JotUrl S.r.l.
Required parameters
parameterdescription
domain_idIDID of the domain for which the SSL certificate has to be installed
Return values
parameterdescription
certificate_domain_idID of the domain the certificate belongs to
cncommon name of the certificate
domainscomma separated list of domains covered by the certificate (e.g., "domain.ext, www.domain.ext")
fingerprintfingerprint of the certificate
hostdomain the certificate belongs to
idID of the certificate
installed1 on success, 0 otherwise
issuerthe certificate issuer
valid_fromthe certificate is valid from this dat, can be in the future (e.g., 2018-05-30 13:38:04)
valid_tothe certificate is valid up to this date, can be in the past (e.g., 2020-05-29 13:38:04)
/domains/certificates/acmes/domains/revoke

access: [WRITE]

This method revokes an SSL certificate for a domain.

Example 1 (json)

Request

https://joturl.com/a/i1/domains/certificates/acmes/domains/revoke?domain_id=58f8dcce8fc8721f5f6d895a7c3928db

Query parameters

domain_id = 58f8dcce8fc8721f5f6d895a7c3928db

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "revoked": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/certificates/acmes/domains/revoke?domain_id=58f8dcce8fc8721f5f6d895a7c3928db&format=xml

Query parameters

domain_id = 58f8dcce8fc8721f5f6d895a7c3928db
   format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <revoked>1</revoked>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/certificates/acmes/domains/revoke?domain_id=58f8dcce8fc8721f5f6d895a7c3928db&format=txt

Query parameters

domain_id = 58f8dcce8fc8721f5f6d895a7c3928db
   format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_revoked=1

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/certificates/acmes/domains/revoke?domain_id=58f8dcce8fc8721f5f6d895a7c3928db&format=plain

Query parameters

domain_id = 58f8dcce8fc8721f5f6d895a7c3928db
   format = plain

Response

1
Required parameters
parameterdescription
domain_idIDID of the domain for which the SSL certificate should be revoked
Return values
parameterdescription
revoked1 on success, 0 otherwise
/domains/certificates/acmes/domains/validate

access: [WRITE]

This method validates a domain. You have to validate a domain before creating an SSL certificate.

Example 1 (json)

Request

https://joturl.com/a/i1/domains/certificates/acmes/domains/validate?domain_id=c27333545bc96623c607d83426052286

Query parameters

domain_id = c27333545bc96623c607d83426052286

Response

{
  "status": "valid"
}

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/certificates/acmes/domains/validate?domain_id=c27333545bc96623c607d83426052286&format=xml

Query parameters

domain_id = c27333545bc96623c607d83426052286
   format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>valid</status>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/certificates/acmes/domains/validate?domain_id=c27333545bc96623c607d83426052286&format=txt

Query parameters

domain_id = c27333545bc96623c607d83426052286
   format = txt

Response

status=valid

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/certificates/acmes/domains/validate?domain_id=c27333545bc96623c607d83426052286&format=plain

Query parameters

domain_id = c27333545bc96623c607d83426052286
   format = plain

Response

valid
Required parameters
parameterdescription
domain_idIDID of the domain to validate
Optional parameters
parameterdescription
include_www_subdomainBOOLEAN1 if the WWW subdomain should be asked, 0 otherwise
Return values
parameterdescription
domainslist of available domains in the certificate
statusstatus of the validation request; call this method until a valid status is returned or a timeout of 30 seconds occurs. If the validation fails, you have to wait at least 30 minutes before retrying [unknown|pending|valid]
/domains/certificates/acmes/users/deactivate

access: [WRITE]

This method deactivates a user on the Let's Encrypt ACME server.

Example 1 (json)

Request

https://joturl.com/a/i1/domains/certificates/acmes/users/deactivate

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deactivated": 0
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/certificates/acmes/users/deactivate?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deactivated>0</deactivated>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/certificates/acmes/users/deactivate?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deactivated=0

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/certificates/acmes/users/deactivate?format=plain

Query parameters

format = plain

Response

0
Return values
parameterdescription
deactivated1 on success, 0 otherwise
/domains/certificates/acmes/users/generatekey

access: [WRITE]

This method generates an RSA key for the user, this key have to be used with all operations on the Let's Encrypt ACME server.

Example 1 (json)

Request

https://joturl.com/a/i1/domains/certificates/acmes/users/generatekey

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "generated": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/certificates/acmes/users/generatekey?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <generated>1</generated>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/certificates/acmes/users/generatekey?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_generated=1

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/certificates/acmes/users/generatekey?format=plain

Query parameters

format = plain

Response

1
Return values
parameterdescription
generated1 on success, 0 otherwise
/domains/certificates/acmes/users/register

access: [WRITE]

This method registers a user on the Let's Encrypt ACME server.

Example 1 (json)

Request

https://joturl.com/a/i1/domains/certificates/acmes/users/register

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "registered": 0
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/certificates/acmes/users/register?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <registered>0</registered>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/certificates/acmes/users/register?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_registered=0

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/certificates/acmes/users/register?format=plain

Query parameters

format = plain

Response

0
Optional parameters
parameterdescription
agreementSTRINGlinks to the Let's Encrypt agreement. Registration on Let's Encrypt ACME server requires two steps; in the first one you have to call this method without parameters, it will return an agreement link and the security parameter nonce, that the user must explicitely approve the agreement; in the second step, you have to call this method with parameters agreement and nonce set to the values returned by the previous call
forceBOOLEAN1 if the registration process have to be forced (overwriting old values), 0 otherwise
nonceIDa random security string to be used during the registration process
Return values
parameterdescription
agreement[OPTIONAL] returned only if agreement is needed (agreement is only in English)
nonce[OPTIONAL] returned only if agreement is needed
registered1 on success, 0 otherwise

/domains/certificates/add

access: [WRITE]

This method allows to upload a certificate for a specific domain.

Example 1 (json)

Request

https://joturl.com/a/i1/domains/certificates/add?domain_id=6e666877484257716e798888484252472b645a4a49518d8d&cert_files_type=pfx&input_pfx_archive=%5Bpfx_file%5D

Query parameters

        domain_id = 6e666877484257716e798888484252472b645a4a49518d8d
  cert_files_type = pfx
input_pfx_archive = [pfx_file]

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "host": "jo.my",
    "id": "69785a4b2f7676744c5a4759642f67524561584b58778d8d",
    "fingerprint": "6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265",
    "valid_from": "2018-01-23 14:58:37",
    "valid_to": "2018-04-23 14:58:37",
    "cn": "jo.my",
    "domains": "jo.my, www.jo.my"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/certificates/add?domain_id=6e666877484257716e798888484252472b645a4a49518d8d&cert_files_type=pfx&input_pfx_archive=%5Bpfx_file%5D&format=xml

Query parameters

        domain_id = 6e666877484257716e798888484252472b645a4a49518d8d
  cert_files_type = pfx
input_pfx_archive = [pfx_file]
           format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <host>jo.my</host>  
    <id>69785a4b2f7676744c5a4759642f67524561584b58778d8d</id>  
    <fingerprint>6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265</fingerprint>  
    <valid_from>2018-01-23 14:58:37</valid_from>  
    <valid_to>2018-04-23 14:58:37</valid_to>  
    <cn>jo.my</cn>  
    <domains>jo.my, www.jo.my</domains>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/certificates/add?domain_id=6e666877484257716e798888484252472b645a4a49518d8d&cert_files_type=pfx&input_pfx_archive=%5Bpfx_file%5D&format=txt

Query parameters

        domain_id = 6e666877484257716e798888484252472b645a4a49518d8d
  cert_files_type = pfx
input_pfx_archive = [pfx_file]
           format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_host=jo.my
result_id=69785a4b2f7676744c5a4759642f67524561584b58778d8d
result_fingerprint=6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265
result_valid_from=2018-01-23 14:58:37
result_valid_to=2018-04-23 14:58:37
result_cn=jo.my
result_domains=jo.my, www.jo.my

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/certificates/add?domain_id=6e666877484257716e798888484252472b645a4a49518d8d&cert_files_type=pfx&input_pfx_archive=%5Bpfx_file%5D&format=plain

Query parameters

        domain_id = 6e666877484257716e798888484252472b645a4a49518d8d
  cert_files_type = pfx
input_pfx_archive = [pfx_file]
           format = plain

Response

jo.my
69785a4b2f7676744c5a4759642f67524561584b58778d8d
6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265
2018-01-23 14:58:37
2018-04-23 14:58:37
jo.my
jo.my, www.jo.my
Required parameters
parameterdescription
cert_files_typeSTRINGthis parameter must be pfx or cert_files, according to the certificate files
domain_idIDID of the domain the certificate belongs to
Optional parameters
parameterdescription
input_ca_certificate1STRINGname of the HTML form field that is used to transfer the ca certificate #1 data, see notes for details
input_ca_certificate2STRINGname of the HTML form field that is used to transfer the ca certificate #2 data, see notes for details
input_ca_certificate3STRINGname of the HTML form field that is used to transfer the ca certificate #2 data, see notes for details
input_certificateSTRINGname of the HTML form field that is used to transfer the certificate data, mandatory if cert_files_type = cert_files , see notes for details
input_pfx_archiveSTRINGname of the HTML form field that is used to transfer the PFX data, mandatory if cert_files_type = pfx , see notes for details
input_private_keySTRINGname of the HTML form field that is used to transfer the private key data, mandatory if cert_files_type = cert_files , see notes for details
pfx_passwordHTMLpassword of the PFX archive, mandatory if cert_files_type = pfx and the PFX archive is protected by a password

NOTES: Parameters starting with input_ are the names of the field of the HTML form used to send data to this method. Form must have enctype = "multipart/form-data" and method = "post".

<form 
    action="/a/i1/domains/certificates/add" 
    method="post" 
    enctype="multipart/form-data">

    <input name="input_pfx_archive" value="pfx_file" type="hidden"/>
    <input name="input_private_key" value="private_key_file" type="hidden"/>
    <input name="input_certificate" value="certificate_file" type="hidden"/>

    <input name="input_ca_certificate1" value="certificate1_file" type="hidden"/>
    <input name="input_ca_certificate2" value="certificate2_file" type="hidden"/>
    <input name="input_ca_certificate3" value="certificate3_file" type="hidden"/>

    [other form fields]

    <input name="pfx_file" type="file"/>
    <input name="private_key_file" type="file"/>    
    <input name="certificate_file" type="file"/> 

    <input name="certificate1_file" type="file"/>
    <input name="certificate2_file" type="file"/>    
    <input name="certificate3_file" type="file"/>     

</form>
Return values
parameterdescription
cncommon name of the certificate
domain_idID of the domain the certificate belongs to
domainscomma separated list of domains covered by the certificate (e.g., "domain.ext, www.domain.ext")
fingerprintfingerprint of the certificate
hostdomain the certificate belongs to
idID of the certificate
valid_fromthe certificate is valid from this dat, can be in the future (e.g., 2018-05-30 13:38:04)
valid_tothe certificate is valid up to this date, can be in the past (e.g., 2020-05-29 13:38:04)

/domains/certificates/count

access: [READ]

This method returns number of certificates associated to a specific domain.

Example 1 (json)

Request

https://joturl.com/a/i1/domains/certificates/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 3
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/certificates/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>3</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/certificates/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=3

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/certificates/count?format=plain

Query parameters

format = plain

Response

3
Optional parameters
parameterdescription
domain_idIDfilters certificates for this domain ID
searchSTRINGcount items by searching them
Return values
parameterdescription
countnumber of (filtered) certificates

/domains/certificates/csr

/domains/certificates/csr/create

access: [WRITE]

This method allows to create a Certificate Signing Request (CSR).

Example 1 (json)

Request

https://joturl.com/a/i1/domains/certificates/csr/create?commonName=domain.ext&organizationName=My+Company&organizationalUnitName=accounting&localityName=Los+Angeles&stateOrProvinceName=California&countryName=US

Query parameters

            commonName = domain.ext
      organizationName = My Company
organizationalUnitName = accounting
          localityName = Los Angeles
   stateOrProvinceName = California
           countryName = US

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "private_key": "-----BEGIN PRIVATE KEY-----
MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDb8gTFlUVgqoPq
0\/vm\/oUo0k9wW2vBpUp3chITNgjMXki05yGMNYCJR7uHCfd0XzVWOi4D7DJMIMml
HMOCVgjnei8FgniH82QCCh7LxHEAscCts32XWjQ9d4datLOrMGwDopj7W62vE+rh
nZNOCM2+NeKvZxN0ZUXTRn2Ed\/CT6tGDUuCsXIBoRwz8p47phewY4ge3xWmoaykE
PP2yVpd1oe5dlliGPT9kY3WuQYHiZ+TakmcC\/TyDZT2J8Q+w5SEMVylehHNd\/8b5
l3f7NhIW50eIZsmY0xgfpV1wsHUp\/oRvyNgRog+B6CnmRuAb96zmXf8HrmnzKQEV
TqdTl05\/AgMBAAECggEBAIF2g7iJlLzBocSn4q6lQlw07u2D4nmpgZutWVZVh\/hD
xyg0pFqTY4Vq48co5q9pG0wWEt\/cN\/73jbnSpIIjgjo+gU8M7UWYzlUk\/9uRVbLC
7ldQP6zHO9iycsnBc8BgUDQTkVjjLejQIIGM7xgPtosvzK7STXFF60PhSiCfOMzX
ZAJguRmHXWeXHhRLNdXknKrPdRwRz6ra8+K0DHwVjTvqHugO2QYZIZQ7fxaf+RGL
AGjkfMdErAHGK2k\/3KZKipXqMCrGgCNn1X4sonfQH1Bjx9PyTL+VD6OAeMUw1HDZ
sGo6MI4oH7GsIf0LkDXPqI0NjwYO93PR7qTzpAcqBwECgYEA7fPrDzrh8V01xEOm
YPhI5RZiXgQ7l2BR1zFOzlxhNbrJZrheX6pgP9otPk4DTDtHJP4DGkC1D3x62b3Q
4sbPq4qDPp3pdlyNNXNbOSjPtFTxKrZB5e8ShVIj9ZfVBgJ1j3N2u97ru1tRGD3y
tbfUo4bIGXgJDDmBSerwi9vw5LcCgYEA7KB4F\/wlkZk2aNHKATu1GZhYKhpGUbhC
vPmiKlgsvvI5FPTeWVf5MO5b41+ctjoN1iIubRDYc+mYcAMNV6oCcmzFwTP6lYVF
K6hpQu7x8hZ1yuehpW3azhm98\/eV7bW48SMcvHl6CGEffGnpQrJ\/ou52mYMhS3Ga
UglUmQGybHkCgYEAm5OsL1P\/YBDiU4UrpiEPgADnpbK8x5dpSvppHRFXWYrbnXaT
9ZZuwbDDfgYBr\/jd5jjSDHscJpjrtauehHcaVn0EnI8gkoumo7jdfvzI+I3E9Hkf
kteB03tGGZAA7qHy\/SywB9uTYvcsiV4Pb3JW6+f2snhB6iU6+\/pI9hiCYvcCgYBf
9V9eUqmllt1iupjR0TXK8GXohQk5QKEH47AoveM\/eBk\/72FwF+X9OtxWo8J4f6h2
yxvKrQcqUnO4EPTLNS2S25uCkyKumgIIB17Qfvfs9cDFDRQXcypFZFkM472QTZ53
Y4bWw+iCF2jeWlD29E4gc9XywSOyZZpwZEpDVlXV+QKBgAqhOA5YI3WpVJga\/hpw
qGoJ8bl5gab0U\/1u9sXdbMKqeyyaFjXo\/RaLdSOG9y4UFJP\/2JMeTh1FRCWaN7rK
6xTT2rrdExqjIXZTtXXFqo9A6wYQ3EWxVBWfmyG7JY08Lwuoc\/zK1OZfUZmOLV+3
yZDE4U3\/Zkgx7gSM\/Ffxw\/62
-----END PRIVATE KEY-----
"
, "csr": "-----BEGIN CERTIFICATE REQUEST-----
MIICvDCCAaQCAQAwdzELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWEx
FDASBgNVBAcMC0xvcyBBbmdlbGVzMRMwEQYDVQQKDApNeSBDb21wYW55MRMwEQYD
VQQLDAphY2NvdW50aW5nMRMwEQYDVQQDDApkb21haW4uZXh0MIIBIjANBgkqhkiG
9w0BAQEFAAOCAQ8AMIIBCgKCAQEA2\/IExZVFYKqD6tP75v6FKNJPcFtrwaVKd3IS
EzYIzF5ItOchjDWAiUe7hwn3dF81VjouA+wyTCDJpRzDglYI53ovBYJ4h\/NkAgoe
y8RxALHArbN9l1o0PXeHWrSzqzBsA6KY+1utrxPq4Z2TTgjNvjXir2cTdGVF00Z9
hHfwk+rRg1LgrFyAaEcM\/KeO6YXsGOIHt8VpqGspBDz9slaXdaHuXZZYhj0\/ZGN1
rkGB4mfk2pJnAv08g2U9ifEPsOUhDFcpXoRzXf\/G+Zd3+zYSFudHiGbJmNMYH6Vd
cLB1Kf6Eb8jYEaIPgegp5kbgG\/es5l3\/B65p8ykBFU6nU5dOfwIDAQABoAAwDQYJ
KoZIhvcNAQELBQADggEBACTnkScHIA5aZ4vgrIFsrETfT5\/Qa+kCFzsVDpEaJOuc
2GujOYydNTwFpsQCcVdW\/LR1mbsiS2CVTMTP+VrppiC\/XIJ0btlXeRNzLZdQ9UaX
xBgj46J79oYxXkIpnskcms3SsrKGnK\/Q1bnus0jpvTlji9DnZglQt9QvzePF15As
QCERgitEUTRKzxvYjozq\/LChtBbNsg5R3uXZyAVGSgn3X+ZF4P4FCd1cEfLfnHq7
XM9eWSo8pWz0VPd9rF4D9kbZ4A9gGHGoZ+abghqFULmJ3iLcQkp+NkmMTncsCvW9
S+WspMDNbVzLxWeBZQ5gMHDgSBdBLFlnHhCT0kYes+s=
-----END CERTIFICATE REQUEST-----
"
} }

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/certificates/csr/create?commonName=domain.ext&organizationName=My+Company&organizationalUnitName=accounting&localityName=Los+Angeles&stateOrProvinceName=California&countryName=US&format=xml

Query parameters

            commonName = domain.ext
      organizationName = My Company
organizationalUnitName = accounting
          localityName = Los Angeles
   stateOrProvinceName = California
           countryName = US
                format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <private_key>-----BEGIN PRIVATE KEY-----
MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDb8gTFlUVgqoPq
0/vm/oUo0k9wW2vBpUp3chITNgjMXki05yGMNYCJR7uHCfd0XzVWOi4D7DJMIMml
HMOCVgjnei8FgniH82QCCh7LxHEAscCts32XWjQ9d4datLOrMGwDopj7W62vE+rh
nZNOCM2+NeKvZxN0ZUXTRn2Ed/CT6tGDUuCsXIBoRwz8p47phewY4ge3xWmoaykE
PP2yVpd1oe5dlliGPT9kY3WuQYHiZ+TakmcC/TyDZT2J8Q+w5SEMVylehHNd/8b5
l3f7NhIW50eIZsmY0xgfpV1wsHUp/oRvyNgRog+B6CnmRuAb96zmXf8HrmnzKQEV
TqdTl05/AgMBAAECggEBAIF2g7iJlLzBocSn4q6lQlw07u2D4nmpgZutWVZVh/hD
xyg0pFqTY4Vq48co5q9pG0wWEt/cN/73jbnSpIIjgjo+gU8M7UWYzlUk/9uRVbLC
7ldQP6zHO9iycsnBc8BgUDQTkVjjLejQIIGM7xgPtosvzK7STXFF60PhSiCfOMzX
ZAJguRmHXWeXHhRLNdXknKrPdRwRz6ra8+K0DHwVjTvqHugO2QYZIZQ7fxaf+RGL
AGjkfMdErAHGK2k/3KZKipXqMCrGgCNn1X4sonfQH1Bjx9PyTL+VD6OAeMUw1HDZ
sGo6MI4oH7GsIf0LkDXPqI0NjwYO93PR7qTzpAcqBwECgYEA7fPrDzrh8V01xEOm
YPhI5RZiXgQ7l2BR1zFOzlxhNbrJZrheX6pgP9otPk4DTDtHJP4DGkC1D3x62b3Q
4sbPq4qDPp3pdlyNNXNbOSjPtFTxKrZB5e8ShVIj9ZfVBgJ1j3N2u97ru1tRGD3y
tbfUo4bIGXgJDDmBSerwi9vw5LcCgYEA7KB4F/wlkZk2aNHKATu1GZhYKhpGUbhC
vPmiKlgsvvI5FPTeWVf5MO5b41+ctjoN1iIubRDYc+mYcAMNV6oCcmzFwTP6lYVF
K6hpQu7x8hZ1yuehpW3azhm98/eV7bW48SMcvHl6CGEffGnpQrJ/ou52mYMhS3Ga
UglUmQGybHkCgYEAm5OsL1P/YBDiU4UrpiEPgADnpbK8x5dpSvppHRFXWYrbnXaT
9ZZuwbDDfgYBr/jd5jjSDHscJpjrtauehHcaVn0EnI8gkoumo7jdfvzI+I3E9Hkf
kteB03tGGZAA7qHy/SywB9uTYvcsiV4Pb3JW6+f2snhB6iU6+/pI9hiCYvcCgYBf
9V9eUqmllt1iupjR0TXK8GXohQk5QKEH47AoveM/eBk/72FwF+X9OtxWo8J4f6h2
yxvKrQcqUnO4EPTLNS2S25uCkyKumgIIB17Qfvfs9cDFDRQXcypFZFkM472QTZ53
Y4bWw+iCF2jeWlD29E4gc9XywSOyZZpwZEpDVlXV+QKBgAqhOA5YI3WpVJga/hpw
qGoJ8bl5gab0U/1u9sXdbMKqeyyaFjXo/RaLdSOG9y4UFJP/2JMeTh1FRCWaN7rK
6xTT2rrdExqjIXZTtXXFqo9A6wYQ3EWxVBWfmyG7JY08Lwuoc/zK1OZfUZmOLV+3
yZDE4U3/Zkgx7gSM/Ffxw/62
-----END PRIVATE KEY-----
</private_key>  
    <csr>-----BEGIN CERTIFICATE REQUEST-----
MIICvDCCAaQCAQAwdzELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWEx
FDASBgNVBAcMC0xvcyBBbmdlbGVzMRMwEQYDVQQKDApNeSBDb21wYW55MRMwEQYD
VQQLDAphY2NvdW50aW5nMRMwEQYDVQQDDApkb21haW4uZXh0MIIBIjANBgkqhkiG
9w0BAQEFAAOCAQ8AMIIBCgKCAQEA2/IExZVFYKqD6tP75v6FKNJPcFtrwaVKd3IS
EzYIzF5ItOchjDWAiUe7hwn3dF81VjouA+wyTCDJpRzDglYI53ovBYJ4h/NkAgoe
y8RxALHArbN9l1o0PXeHWrSzqzBsA6KY+1utrxPq4Z2TTgjNvjXir2cTdGVF00Z9
hHfwk+rRg1LgrFyAaEcM/KeO6YXsGOIHt8VpqGspBDz9slaXdaHuXZZYhj0/ZGN1
rkGB4mfk2pJnAv08g2U9ifEPsOUhDFcpXoRzXf/G+Zd3+zYSFudHiGbJmNMYH6Vd
cLB1Kf6Eb8jYEaIPgegp5kbgG/es5l3/B65p8ykBFU6nU5dOfwIDAQABoAAwDQYJ
KoZIhvcNAQELBQADggEBACTnkScHIA5aZ4vgrIFsrETfT5/Qa+kCFzsVDpEaJOuc
2GujOYydNTwFpsQCcVdW/LR1mbsiS2CVTMTP+VrppiC/XIJ0btlXeRNzLZdQ9UaX
xBgj46J79oYxXkIpnskcms3SsrKGnK/Q1bnus0jpvTlji9DnZglQt9QvzePF15As
QCERgitEUTRKzxvYjozq/LChtBbNsg5R3uXZyAVGSgn3X+ZF4P4FCd1cEfLfnHq7
XM9eWSo8pWz0VPd9rF4D9kbZ4A9gGHGoZ+abghqFULmJ3iLcQkp+NkmMTncsCvW9
S+WspMDNbVzLxWeBZQ5gMHDgSBdBLFlnHhCT0kYes+s=
-----END CERTIFICATE REQUEST-----
</csr>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/certificates/csr/create?commonName=domain.ext&organizationName=My+Company&organizationalUnitName=accounting&localityName=Los+Angeles&stateOrProvinceName=California&countryName=US&format=txt

Query parameters

            commonName = domain.ext
      organizationName = My Company
organizationalUnitName = accounting
          localityName = Los Angeles
   stateOrProvinceName = California
           countryName = US
                format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_private_key=-----BEGIN PRIVATE KEY-----MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDb8gTFlUVgqoPq0/vm/oUo0k9wW2vBpUp3chITNgjMXki05yGMNYCJR7uHCfd0XzVWOi4D7DJMIMmlHMOCVgjnei8FgniH82QCCh7LxHEAscCts32XWjQ9d4datLOrMGwDopj7W62vE+rhnZNOCM2+NeKvZxN0ZUXTRn2Ed/CT6tGDUuCsXIBoRwz8p47phewY4ge3xWmoaykEPP2yVpd1oe5dlliGPT9kY3WuQYHiZ+TakmcC/TyDZT2J8Q+w5SEMVylehHNd/8b5l3f7NhIW50eIZsmY0xgfpV1wsHUp/oRvyNgRog+B6CnmRuAb96zmXf8HrmnzKQEVTqdTl05/AgMBAAECggEBAIF2g7iJlLzBocSn4q6lQlw07u2D4nmpgZutWVZVh/hDxyg0pFqTY4Vq48co5q9pG0wWEt/cN/73jbnSpIIjgjo+gU8M7UWYzlUk/9uRVbLC7ldQP6zHO9iycsnBc8BgUDQTkVjjLejQIIGM7xgPtosvzK7STXFF60PhSiCfOMzXZAJguRmHXWeXHhRLNdXknKrPdRwRz6ra8+K0DHwVjTvqHugO2QYZIZQ7fxaf+RGLAGjkfMdErAHGK2k/3KZKipXqMCrGgCNn1X4sonfQH1Bjx9PyTL+VD6OAeMUw1HDZsGo6MI4oH7GsIf0LkDXPqI0NjwYO93PR7qTzpAcqBwECgYEA7fPrDzrh8V01xEOmYPhI5RZiXgQ7l2BR1zFOzlxhNbrJZrheX6pgP9otPk4DTDtHJP4DGkC1D3x62b3Q4sbPq4qDPp3pdlyNNXNbOSjPtFTxKrZB5e8ShVIj9ZfVBgJ1j3N2u97ru1tRGD3ytbfUo4bIGXgJDDmBSerwi9vw5LcCgYEA7KB4F/wlkZk2aNHKATu1GZhYKhpGUbhCvPmiKlgsvvI5FPTeWVf5MO5b41+ctjoN1iIubRDYc+mYcAMNV6oCcmzFwTP6lYVFK6hpQu7x8hZ1yuehpW3azhm98/eV7bW48SMcvHl6CGEffGnpQrJ/ou52mYMhS3GaUglUmQGybHkCgYEAm5OsL1P/YBDiU4UrpiEPgADnpbK8x5dpSvppHRFXWYrbnXaT9ZZuwbDDfgYBr/jd5jjSDHscJpjrtauehHcaVn0EnI8gkoumo7jdfvzI+I3E9HkfkteB03tGGZAA7qHy/SywB9uTYvcsiV4Pb3JW6+f2snhB6iU6+/pI9hiCYvcCgYBf9V9eUqmllt1iupjR0TXK8GXohQk5QKEH47AoveM/eBk/72FwF+X9OtxWo8J4f6h2yxvKrQcqUnO4EPTLNS2S25uCkyKumgIIB17Qfvfs9cDFDRQXcypFZFkM472QTZ53Y4bWw+iCF2jeWlD29E4gc9XywSOyZZpwZEpDVlXV+QKBgAqhOA5YI3WpVJga/hpwqGoJ8bl5gab0U/1u9sXdbMKqeyyaFjXo/RaLdSOG9y4UFJP/2JMeTh1FRCWaN7rK6xTT2rrdExqjIXZTtXXFqo9A6wYQ3EWxVBWfmyG7JY08Lwuoc/zK1OZfUZmOLV+3yZDE4U3/Zkgx7gSM/Ffxw/62-----END PRIVATE KEY-----
result_csr=-----BEGIN CERTIFICATE REQUEST-----MIICvDCCAaQCAQAwdzELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFDASBgNVBAcMC0xvcyBBbmdlbGVzMRMwEQYDVQQKDApNeSBDb21wYW55MRMwEQYDVQQLDAphY2NvdW50aW5nMRMwEQYDVQQDDApkb21haW4uZXh0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA2/IExZVFYKqD6tP75v6FKNJPcFtrwaVKd3ISEzYIzF5ItOchjDWAiUe7hwn3dF81VjouA+wyTCDJpRzDglYI53ovBYJ4h/NkAgoey8RxALHArbN9l1o0PXeHWrSzqzBsA6KY+1utrxPq4Z2TTgjNvjXir2cTdGVF00Z9hHfwk+rRg1LgrFyAaEcM/KeO6YXsGOIHt8VpqGspBDz9slaXdaHuXZZYhj0/ZGN1rkGB4mfk2pJnAv08g2U9ifEPsOUhDFcpXoRzXf/G+Zd3+zYSFudHiGbJmNMYH6VdcLB1Kf6Eb8jYEaIPgegp5kbgG/es5l3/B65p8ykBFU6nU5dOfwIDAQABoAAwDQYJKoZIhvcNAQELBQADggEBACTnkScHIA5aZ4vgrIFsrETfT5/Qa+kCFzsVDpEaJOuc2GujOYydNTwFpsQCcVdW/LR1mbsiS2CVTMTP+VrppiC/XIJ0btlXeRNzLZdQ9UaXxBgj46J79oYxXkIpnskcms3SsrKGnK/Q1bnus0jpvTlji9DnZglQt9QvzePF15AsQCERgitEUTRKzxvYjozq/LChtBbNsg5R3uXZyAVGSgn3X+ZF4P4FCd1cEfLfnHq7XM9eWSo8pWz0VPd9rF4D9kbZ4A9gGHGoZ+abghqFULmJ3iLcQkp+NkmMTncsCvW9S+WspMDNbVzLxWeBZQ5gMHDgSBdBLFlnHhCT0kYes+s=-----END CERTIFICATE REQUEST-----

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/certificates/csr/create?commonName=domain.ext&organizationName=My+Company&organizationalUnitName=accounting&localityName=Los+Angeles&stateOrProvinceName=California&countryName=US&format=plain

Query parameters

            commonName = domain.ext
      organizationName = My Company
organizationalUnitName = accounting
          localityName = Los Angeles
   stateOrProvinceName = California
           countryName = US
                format = plain

Response

-----BEGIN PRIVATE KEY-----MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDb8gTFlUVgqoPq0/vm/oUo0k9wW2vBpUp3chITNgjMXki05yGMNYCJR7uHCfd0XzVWOi4D7DJMIMmlHMOCVgjnei8FgniH82QCCh7LxHEAscCts32XWjQ9d4datLOrMGwDopj7W62vE+rhnZNOCM2+NeKvZxN0ZUXTRn2Ed/CT6tGDUuCsXIBoRwz8p47phewY4ge3xWmoaykEPP2yVpd1oe5dlliGPT9kY3WuQYHiZ+TakmcC/TyDZT2J8Q+w5SEMVylehHNd/8b5l3f7NhIW50eIZsmY0xgfpV1wsHUp/oRvyNgRog+B6CnmRuAb96zmXf8HrmnzKQEVTqdTl05/AgMBAAECggEBAIF2g7iJlLzBocSn4q6lQlw07u2D4nmpgZutWVZVh/hDxyg0pFqTY4Vq48co5q9pG0wWEt/cN/73jbnSpIIjgjo+gU8M7UWYzlUk/9uRVbLC7ldQP6zHO9iycsnBc8BgUDQTkVjjLejQIIGM7xgPtosvzK7STXFF60PhSiCfOMzXZAJguRmHXWeXHhRLNdXknKrPdRwRz6ra8+K0DHwVjTvqHugO2QYZIZQ7fxaf+RGLAGjkfMdErAHGK2k/3KZKipXqMCrGgCNn1X4sonfQH1Bjx9PyTL+VD6OAeMUw1HDZsGo6MI4oH7GsIf0LkDXPqI0NjwYO93PR7qTzpAcqBwECgYEA7fPrDzrh8V01xEOmYPhI5RZiXgQ7l2BR1zFOzlxhNbrJZrheX6pgP9otPk4DTDtHJP4DGkC1D3x62b3Q4sbPq4qDPp3pdlyNNXNbOSjPtFTxKrZB5e8ShVIj9ZfVBgJ1j3N2u97ru1tRGD3ytbfUo4bIGXgJDDmBSerwi9vw5LcCgYEA7KB4F/wlkZk2aNHKATu1GZhYKhpGUbhCvPmiKlgsvvI5FPTeWVf5MO5b41+ctjoN1iIubRDYc+mYcAMNV6oCcmzFwTP6lYVFK6hpQu7x8hZ1yuehpW3azhm98/eV7bW48SMcvHl6CGEffGnpQrJ/ou52mYMhS3GaUglUmQGybHkCgYEAm5OsL1P/YBDiU4UrpiEPgADnpbK8x5dpSvppHRFXWYrbnXaT9ZZuwbDDfgYBr/jd5jjSDHscJpjrtauehHcaVn0EnI8gkoumo7jdfvzI+I3E9HkfkteB03tGGZAA7qHy/SywB9uTYvcsiV4Pb3JW6+f2snhB6iU6+/pI9hiCYvcCgYBf9V9eUqmllt1iupjR0TXK8GXohQk5QKEH47AoveM/eBk/72FwF+X9OtxWo8J4f6h2yxvKrQcqUnO4EPTLNS2S25uCkyKumgIIB17Qfvfs9cDFDRQXcypFZFkM472QTZ53Y4bWw+iCF2jeWlD29E4gc9XywSOyZZpwZEpDVlXV+QKBgAqhOA5YI3WpVJga/hpwqGoJ8bl5gab0U/1u9sXdbMKqeyyaFjXo/RaLdSOG9y4UFJP/2JMeTh1FRCWaN7rK6xTT2rrdExqjIXZTtXXFqo9A6wYQ3EWxVBWfmyG7JY08Lwuoc/zK1OZfUZmOLV+3yZDE4U3/Zkgx7gSM/Ffxw/62-----END PRIVATE KEY-----
-----BEGIN CERTIFICATE REQUEST-----MIICvDCCAaQCAQAwdzELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFDASBgNVBAcMC0xvcyBBbmdlbGVzMRMwEQYDVQQKDApNeSBDb21wYW55MRMwEQYDVQQLDAphY2NvdW50aW5nMRMwEQYDVQQDDApkb21haW4uZXh0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA2/IExZVFYKqD6tP75v6FKNJPcFtrwaVKd3ISEzYIzF5ItOchjDWAiUe7hwn3dF81VjouA+wyTCDJpRzDglYI53ovBYJ4h/NkAgoey8RxALHArbN9l1o0PXeHWrSzqzBsA6KY+1utrxPq4Z2TTgjNvjXir2cTdGVF00Z9hHfwk+rRg1LgrFyAaEcM/KeO6YXsGOIHt8VpqGspBDz9slaXdaHuXZZYhj0/ZGN1rkGB4mfk2pJnAv08g2U9ifEPsOUhDFcpXoRzXf/G+Zd3+zYSFudHiGbJmNMYH6VdcLB1Kf6Eb8jYEaIPgegp5kbgG/es5l3/B65p8ykBFU6nU5dOfwIDAQABoAAwDQYJKoZIhvcNAQELBQADggEBACTnkScHIA5aZ4vgrIFsrETfT5/Qa+kCFzsVDpEaJOuc2GujOYydNTwFpsQCcVdW/LR1mbsiS2CVTMTP+VrppiC/XIJ0btlXeRNzLZdQ9UaXxBgj46J79oYxXkIpnskcms3SsrKGnK/Q1bnus0jpvTlji9DnZglQt9QvzePF15AsQCERgitEUTRKzxvYjozq/LChtBbNsg5R3uXZyAVGSgn3X+ZF4P4FCd1cEfLfnHq7XM9eWSo8pWz0VPd9rF4D9kbZ4A9gGHGoZ+abghqFULmJ3iLcQkp+NkmMTncsCvW9S+WspMDNbVzLxWeBZQ5gMHDgSBdBLFlnHhCT0kYes+s=-----END CERTIFICATE REQUEST-----
Required parameters
parameterdescription
commonNameSTRINGthe Fully Qualified Domain Name (FQDN) for which you are requesting the SSL Certificate, it must contain domain you are requesting a certifacate for (e.g., domain.ext, *.domain.ext)
countryNameSTRING2-digit code of the country (ISO Alpha-2) the company is based on (e.g., US)
localityNameSTRINGthe full name of the locality the company is based on (e.g., Los Angeles)
organizationNameSTRINGthe full legal company or personal name, as legally registered, that is requesting the certificate (e.g., My Company)
organizationalUnitNameSTRINGwhichever branch of the company is ordering the certificate (e.g., accounting, marketing)
stateOrProvinceNameSTRINGthe full name of the state or province the company is based on (e.g., California)
Return values
parameterdescription
csrCertificate request (CSR)
private_keyPrivate key

/domains/certificates/delete

access: [WRITE]

This method deletes a certificate.

Example 1 (json)

Request

https://joturl.com/a/i1/domains/certificates/delete?id=3000

Query parameters

id = 3000

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/certificates/delete?id=3000&format=xml

Query parameters

    id = 3000
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/certificates/delete?id=3000&format=txt

Query parameters

    id = 3000
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/certificates/delete?id=3000&format=plain

Query parameters

    id = 3000
format = plain

Response

1

Example 5 (json)

Request

https://joturl.com/a/i1/domains/certificates/delete?id=100000

Query parameters

id = 100000

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 0
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/domains/certificates/delete?id=100000&format=xml

Query parameters

    id = 100000
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>0</deleted>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/domains/certificates/delete?id=100000&format=txt

Query parameters

    id = 100000
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=0

Example 8 (plain)

Request

https://joturl.com/a/i1/domains/certificates/delete?id=100000&format=plain

Query parameters

    id = 100000
format = plain

Response

0
Required parameters
parameterdescription
idIDID of the certificate to delete
Return values
parameterdescription
deleted1 if the delete successes, 0 otherwise

/domains/certificates/info

access: [READ]

This method returns information about a certificate. Required information can be passed by using fields.

Example 1 (json)

Request

https://joturl.com/a/i1/domains/certificates/info?id=6e666877484257716e798888484252472b645a4a49518d8d&fields=deeplink_id,host,for_trials,force_https,domain_domain_id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,cn,domain_id,domains,fingerprint,id,valid_from,valid_to,deeplink_name,installed

Query parameters

    id = 6e666877484257716e798888484252472b645a4a49518d8d
fields = deeplink_id,host,for_trials,force_https,domain_domain_id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,cn,domain_id,domains,fingerprint,id,valid_from,valid_to,deeplink_name,installed

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "host": "jo.my",
    "cn": "jo.my",
    "domain_id": "6e666877484257716e798888484252472b645a4a49518d8d",
    "domains": "jo.my, www.jo.my",
    "fingerprint": "6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265",
    "id": "69785a4b2f7676744c5a4759642f67524561584b58778d8d",
    "valid_from": "2018-01-23 14:58:37",
    "valid_to": "2018-04-23 14:58:37",
    "installed": 0
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/certificates/info?id=6e666877484257716e798888484252472b645a4a49518d8d&fields=deeplink_id,host,for_trials,force_https,domain_domain_id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,cn,domain_id,domains,fingerprint,id,valid_from,valid_to,deeplink_name,installed&format=xml

Query parameters

    id = 6e666877484257716e798888484252472b645a4a49518d8d
fields = deeplink_id,host,for_trials,force_https,domain_domain_id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,cn,domain_id,domains,fingerprint,id,valid_from,valid_to,deeplink_name,installed
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <host>jo.my</host>  
    <cn>jo.my</cn>  
    <domain_id>6e666877484257716e798888484252472b645a4a49518d8d</domain_id>  
    <domains>jo.my, www.jo.my</domains>  
    <fingerprint>6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265</fingerprint>  
    <id>69785a4b2f7676744c5a4759642f67524561584b58778d8d</id>  
    <valid_from>2018-01-23 14:58:37</valid_from>  
    <valid_to>2018-04-23 14:58:37</valid_to>  
    <installed>0</installed>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/certificates/info?id=6e666877484257716e798888484252472b645a4a49518d8d&fields=deeplink_id,host,for_trials,force_https,domain_domain_id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,cn,domain_id,domains,fingerprint,id,valid_from,valid_to,deeplink_name,installed&format=txt

Query parameters

    id = 6e666877484257716e798888484252472b645a4a49518d8d
fields = deeplink_id,host,for_trials,force_https,domain_domain_id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,cn,domain_id,domains,fingerprint,id,valid_from,valid_to,deeplink_name,installed
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_host=jo.my
result_cn=jo.my
result_domain_id=6e666877484257716e798888484252472b645a4a49518d8d
result_domains=jo.my, www.jo.my
result_fingerprint=6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265
result_id=69785a4b2f7676744c5a4759642f67524561584b58778d8d
result_valid_from=2018-01-23 14:58:37
result_valid_to=2018-04-23 14:58:37
result_installed=0

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/certificates/info?id=6e666877484257716e798888484252472b645a4a49518d8d&fields=deeplink_id,host,for_trials,force_https,domain_domain_id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,cn,domain_id,domains,fingerprint,id,valid_from,valid_to,deeplink_name,installed&format=plain

Query parameters

    id = 6e666877484257716e798888484252472b645a4a49518d8d
fields = deeplink_id,host,for_trials,force_https,domain_domain_id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,cn,domain_id,domains,fingerprint,id,valid_from,valid_to,deeplink_name,installed
format = plain

Response

jo.my
jo.my
6e666877484257716e798888484252472b645a4a49518d8d
jo.my, www.jo.my
6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265
69785a4b2f7676744c5a4759642f67524561584b58778d8d
2018-01-23 14:58:37
2018-04-23 14:58:37
0
Required parameters
parameterdescription
fieldsARRAYcomma separated list of fields to return, available fields: deeplink_id, host, for_trials, force_https, domain_domain_id, aliases, nickname, logo, redirect_url, favicon_url, robots_txt, cn, domain_id, domains, fingerprint, id, valid_from, valid_to, deeplink_name, installed
idIDID of the certificate
Return values
parameterdescription
cncommon name of the certificate
domain_idID of the domain the certificate belongs to
domainscomma separated list of domains covered by the certificate (e.g., "domain.ext, www.domain.ext")
fingerprintfingerprint of the certificate
hostdomain the certificate belongs to
idID of the certificate
installedpropagation percentage of the certificate installation (e.g. 12.34%, 100%)
valid_fromthe certificate is valid from this dat, can be in the future (e.g., 2018-05-30 13:38:04)
valid_tothe certificate is valid up to this date, can be in the past (e.g., 2020-05-29 13:38:04)

/domains/certificates/list

access: [READ]

This method returns the certificates associated to the logged users.

Example 1 (json)

Request

https://joturl.com/a/i1/domains/certificates/list?fields=deeplink_id,host,for_trials,force_https,domain_domain_id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,cn,domain_id,domains,fingerprint,id,valid_from,valid_to,deeplink_name,installed,count,issuer

Query parameters

fields = deeplink_id,host,for_trials,force_https,domain_domain_id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,cn,domain_id,domains,fingerprint,id,valid_from,valid_to,deeplink_name,installed,count,issuer

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 2,
    "data": [
      {
        "host": "jo.my",
        "cn": "jo.my",
        "domain_id": "6e666877484257716e798888484252472b645a4a49518d8d",
        "domains": "jo.my, www.jo.my",
        "fingerprint": "6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265",
        "id": "69785a4b2f7676744c5a4759642f67524561584b58778d8d",
        "valid_from": "2018-01-23 14:58:37",
        "valid_to": "2018-04-23 14:58:37",
        "issuer": "JotUrl S.r.l.",
        "installed": 0
      },
      {
        "host": "joturl.com",
        "cn": "*.joturl.com",
        "domain_id": "544a5451745446616542676449497450686f425446414d4d",
        "domains": "*.joturl.com, joturl.com",
        "fingerprint": "51D012A79F7B9FAB1DE55015CDE19E448CBD7EDB",
        "id": "54576e66564a74412b70596c577175424968715464414d4d",
        "valid_from": "2017-04-06 00:00:00",
        "valid_to": "2028-04-20 23:59:59",
        "issuer": "JotUrl S.r.l.",
        "installed": 100
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/certificates/list?fields=deeplink_id,host,for_trials,force_https,domain_domain_id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,cn,domain_id,domains,fingerprint,id,valid_from,valid_to,deeplink_name,installed,count,issuer&format=xml

Query parameters

fields = deeplink_id,host,for_trials,force_https,domain_domain_id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,cn,domain_id,domains,fingerprint,id,valid_from,valid_to,deeplink_name,installed,count,issuer
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>2</count>  
    <data>
      <i0>
        <host>jo.my</host>  
        <cn>jo.my</cn>  
        <domain_id>6e666877484257716e798888484252472b645a4a49518d8d</domain_id>  
        <domains>jo.my, www.jo.my</domains>  
        <fingerprint>6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265</fingerprint>  
        <id>69785a4b2f7676744c5a4759642f67524561584b58778d8d</id>  
        <valid_from>2018-01-23 14:58:37</valid_from>  
        <valid_to>2018-04-23 14:58:37</valid_to>  
        <issuer>JotUrl S.r.l.</issuer>  
        <installed>0</installed>  
      </i0>  
      <i1>
        <host>joturl.com</host>  
        <cn>*.joturl.com</cn>  
        <domain_id>544a5451745446616542676449497450686f425446414d4d</domain_id>  
        <domains>*.joturl.com, joturl.com</domains>  
        <fingerprint>51D012A79F7B9FAB1DE55015CDE19E448CBD7EDB</fingerprint>  
        <id>54576e66564a74412b70596c577175424968715464414d4d</id>  
        <valid_from>2017-04-06 00:00:00</valid_from>  
        <valid_to>2028-04-20 23:59:59</valid_to>  
        <issuer>JotUrl S.r.l.</issuer>  
        <installed>100</installed>  
      </i1>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/certificates/list?fields=deeplink_id,host,for_trials,force_https,domain_domain_id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,cn,domain_id,domains,fingerprint,id,valid_from,valid_to,deeplink_name,installed,count,issuer&format=txt

Query parameters

fields = deeplink_id,host,for_trials,force_https,domain_domain_id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,cn,domain_id,domains,fingerprint,id,valid_from,valid_to,deeplink_name,installed,count,issuer
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=2
result_data_0_host=jo.my
result_data_0_cn=jo.my
result_data_0_domain_id=6e666877484257716e798888484252472b645a4a49518d8d
result_data_0_domains=jo.my, www.jo.my
result_data_0_fingerprint=6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265
result_data_0_id=69785a4b2f7676744c5a4759642f67524561584b58778d8d
result_data_0_valid_from=2018-01-23 14:58:37
result_data_0_valid_to=2018-04-23 14:58:37
result_data_0_issuer=JotUrl S.r.l.
result_data_0_installed=0
result_data_1_host=joturl.com
result_data_1_cn=*.joturl.com
result_data_1_domain_id=544a5451745446616542676449497450686f425446414d4d
result_data_1_domains=*.joturl.com, joturl.com
result_data_1_fingerprint=51D012A79F7B9FAB1DE55015CDE19E448CBD7EDB
result_data_1_id=54576e66564a74412b70596c577175424968715464414d4d
result_data_1_valid_from=2017-04-06 00:00:00
result_data_1_valid_to=2028-04-20 23:59:59
result_data_1_issuer=JotUrl S.r.l.
result_data_1_installed=100

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/certificates/list?fields=deeplink_id,host,for_trials,force_https,domain_domain_id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,cn,domain_id,domains,fingerprint,id,valid_from,valid_to,deeplink_name,installed,count,issuer&format=plain

Query parameters

fields = deeplink_id,host,for_trials,force_https,domain_domain_id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,cn,domain_id,domains,fingerprint,id,valid_from,valid_to,deeplink_name,installed,count,issuer
format = plain

Response

2
jo.my
jo.my
6e666877484257716e798888484252472b645a4a49518d8d
jo.my, www.jo.my
6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265
69785a4b2f7676744c5a4759642f67524561584b58778d8d
2018-01-23 14:58:37
2018-04-23 14:58:37
JotUrl S.r.l.
0
joturl.com
*.joturl.com
544a5451745446616542676449497450686f425446414d4d
*.joturl.com, joturl.com
51D012A79F7B9FAB1DE55015CDE19E448CBD7EDB
54576e66564a74412b70596c577175424968715464414d4d
2017-04-06 00:00:00
2028-04-20 23:59:59
JotUrl S.r.l.
100

Example 5 (json)

Request

https://joturl.com/a/i1/domains/certificates/list?domain_id=6e666877484257716e798888484252472b645a4a49518d8d&fields=deeplink_id,host,for_trials,force_https,domain_domain_id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,cn,domain_id,domains,fingerprint,id,valid_from,valid_to,deeplink_name,installed,count,issuer

Query parameters

domain_id = 6e666877484257716e798888484252472b645a4a49518d8d
   fields = deeplink_id,host,for_trials,force_https,domain_domain_id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,cn,domain_id,domains,fingerprint,id,valid_from,valid_to,deeplink_name,installed,count,issuer

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 1,
    "data": [
      {
        "host": "jo.my",
        "cn": "jo.my",
        "domain_id": "6e666877484257716e798888484252472b645a4a49518d8d",
        "domains": "jo.my, www.jo.my",
        "fingerprint": "6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265",
        "id": "69785a4b2f7676744c5a4759642f67524561584b58778d8d",
        "valid_from": "2018-01-23 14:58:37",
        "valid_to": "2018-04-23 14:58:37",
        "issuer": "JotUrl S.r.l.",
        "installed": 0
      }
    ]
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/domains/certificates/list?domain_id=6e666877484257716e798888484252472b645a4a49518d8d&fields=deeplink_id,host,for_trials,force_https,domain_domain_id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,cn,domain_id,domains,fingerprint,id,valid_from,valid_to,deeplink_name,installed,count,issuer&format=xml

Query parameters

domain_id = 6e666877484257716e798888484252472b645a4a49518d8d
   fields = deeplink_id,host,for_trials,force_https,domain_domain_id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,cn,domain_id,domains,fingerprint,id,valid_from,valid_to,deeplink_name,installed,count,issuer
   format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>1</count>  
    <data>
      <i0>
        <host>jo.my</host>  
        <cn>jo.my</cn>  
        <domain_id>6e666877484257716e798888484252472b645a4a49518d8d</domain_id>  
        <domains>jo.my, www.jo.my</domains>  
        <fingerprint>6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265</fingerprint>  
        <id>69785a4b2f7676744c5a4759642f67524561584b58778d8d</id>  
        <valid_from>2018-01-23 14:58:37</valid_from>  
        <valid_to>2018-04-23 14:58:37</valid_to>  
        <issuer>JotUrl S.r.l.</issuer>  
        <installed>0</installed>  
      </i0>  
    </data>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/domains/certificates/list?domain_id=6e666877484257716e798888484252472b645a4a49518d8d&fields=deeplink_id,host,for_trials,force_https,domain_domain_id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,cn,domain_id,domains,fingerprint,id,valid_from,valid_to,deeplink_name,installed,count,issuer&format=txt

Query parameters

domain_id = 6e666877484257716e798888484252472b645a4a49518d8d
   fields = deeplink_id,host,for_trials,force_https,domain_domain_id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,cn,domain_id,domains,fingerprint,id,valid_from,valid_to,deeplink_name,installed,count,issuer
   format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=1
result_data_0_host=jo.my
result_data_0_cn=jo.my
result_data_0_domain_id=6e666877484257716e798888484252472b645a4a49518d8d
result_data_0_domains=jo.my, www.jo.my
result_data_0_fingerprint=6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265
result_data_0_id=69785a4b2f7676744c5a4759642f67524561584b58778d8d
result_data_0_valid_from=2018-01-23 14:58:37
result_data_0_valid_to=2018-04-23 14:58:37
result_data_0_issuer=JotUrl S.r.l.
result_data_0_installed=0

Example 8 (plain)

Request

https://joturl.com/a/i1/domains/certificates/list?domain_id=6e666877484257716e798888484252472b645a4a49518d8d&fields=deeplink_id,host,for_trials,force_https,domain_domain_id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,cn,domain_id,domains,fingerprint,id,valid_from,valid_to,deeplink_name,installed,count,issuer&format=plain

Query parameters

domain_id = 6e666877484257716e798888484252472b645a4a49518d8d
   fields = deeplink_id,host,for_trials,force_https,domain_domain_id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,cn,domain_id,domains,fingerprint,id,valid_from,valid_to,deeplink_name,installed,count,issuer
   format = plain

Response

1
jo.my
jo.my
6e666877484257716e798888484252472b645a4a49518d8d
jo.my, www.jo.my
6A5ACE78B0B5604B66688AA5092B0BA0CE2FD265
69785a4b2f7676744c5a4759642f67524561584b58778d8d
2018-01-23 14:58:37
2018-04-23 14:58:37
JotUrl S.r.l.
0
Required parameters
parameterdescription
fieldsARRAYcomma separated list of fields to return, available fields: deeplink_id, host, for_trials, force_https, domain_domain_id, aliases, nickname, logo, redirect_url, favicon_url, robots_txt, cn, domain_id, domains, fingerprint, id, valid_from, valid_to, deeplink_name, installed, count, issuer
Optional parameters
parameterdescription
domain_idIDfilters certificates for this domain ID
lengthINTEGERextracts this number of items (maxmimum allowed: 100)
orderbyARRAYorders items by field, available fields: deeplink_id, host, for_trials, force_https, domain_domain_id, aliases, nickname, logo, redirect_url, favicon_url, robots_txt, cn, domain_id, domains, fingerprint, id, valid_from, valid_to, deeplink_name, installed, count, issuer
searchSTRINGfilters items to be extracted by searching them
sortSTRINGsorts items in ascending (ASC) or descending (DESC) order
startINTEGERstarts to extract items from this position
Return values
parameterdescription
count[OPTIONAL] total number of (filtered) certificates, returned only if count is passed in fields
dataarray containing required information on certificates

/domains/count

access: [READ]

This method returns the number of user's domains.

Example 1 (json)

Request

https://joturl.com/a/i1/domains/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 5
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>5</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=5

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/count?format=plain

Query parameters

format = plain

Response

5

Example 5 (json)

Request

https://joturl.com/a/i1/domains/count?search=test

Query parameters

search = test

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 3
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/domains/count?search=test&format=xml

Query parameters

search = test
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>3</count>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/domains/count?search=test&format=txt

Query parameters

search = test
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=3

Example 8 (plain)

Request

https://joturl.com/a/i1/domains/count?search=test&format=plain

Query parameters

search = test
format = plain

Response

3
Optional parameters
parameterdescription
is_defaultBOOLEANif 1 this method counts only the default domain
is_ownerBOOLEANif 1 this method counts only domains owned by the logged user, if 0 it returns only shared domains
searchSTRINGcount items by searching them
Return values
parameterdescription
countnumber of domains the user has access to (filtered by search if passed)

access: [WRITE]

Add a deep link configuration for the logged user.

Example 1 (json)

Request

https://joturl.com/a/i1/domains/deeplinks/add?name=deep+configuration+domain_name&android=%5B%0A++++%7B%0A++++++++%22relation%22%3A+%5B%0A++++++++++++%22delegate_permission%2Fcommon.handle_all_urls%22%0A++++++++%5D,%0A++++++++%22target%22%3A+%7B%0A++++++++++++%22namespace%22%3A+%22android_app%22,%0A++++++++++++%22package_name%22%3A+%22com.example.app%22,%0A++++++++++++%22sha256_cert_fingerprints%22%3A+%5B%0A++++++++++++++++%22hash_of_app_certificate%22%0A++++++++++++%5D%0A++++++++%7D%0A++++%7D%0A%5D&ios=%7B%0A++++%22applinks%22%3A+%7B%0A++++++++%22apps%22%3A+%5B%5D,%0A++++++++%22details%22%3A+%5B%0A++++++++++++%7B%0A++++++++++++++++%22appID%22%3A+%22D3KQX62K1A.com.example.photoapp%22,%0A++++++++++++++++%22paths%22%3A+%5B%0A++++++++++++++++++++%22%2Falbums%22%0A++++++++++++++++%5D%0A++++++++++++%7D,%0A++++++++++++%7B%0A++++++++++++++++%22appID%22%3A+%22D3KQX62K1A.com.example.videoapp%22,%0A++++++++++++++++%22paths%22%3A+%5B%0A++++++++++++++++++++%22%2Fvideos%22%0A++++++++++++++++%5D%0A++++++++++++%7D%0A++++++++%5D%0A++++%7D%0A%7D

Query parameters

   name = deep configuration domain_name
android = [
    {
        "relation": [
            "delegate_permission/common.handle_all_urls"
        ],
        "target": {
            "namespace": "android_app",
            "package_name": "com.example.app",
            "sha256_cert_fingerprints": [
                "hash_of_app_certificate"
            ]
        }
    }
]
    ios = {
    "applinks": {
        "apps": [],
        "details": [
            {
                "appID": "D3KQX62K1A.com.example.photoapp",
                "paths": [
                    "/albums"
                ]
            },
            {
                "appID": "D3KQX62K1A.com.example.videoapp",
                "paths": [
                    "/videos"
                ]
            }
        ]
    }
}

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "1234567890abcdef",
    "name": "deep configuration domain_name",
    "android": "[
{
\"relation\": [
\"delegate_permission\/common.handle_all_urls\"
],
\"target\": {
\"namespace\": \"android_app\",
\"package_name\": \"com.example.app\",
\"sha256_cert_fingerprints\": [
\"hash_of_app_certificate\"
]
}
}
]"
, "ios": "{
\"applinks\": {
\"apps\": [],
\"details\": [
{
\"appID\": \"D3KQX62K1A.com.example.photoapp\",
\"paths\": [
\"\/albums\"
]
},
{
\"appID\": \"D3KQX62K1A.com.example.videoapp\",
\"paths\": [
\"\/videos\"
]
}
]
}
}"
} }

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/deeplinks/add?name=deep+configuration+domain_name&android=%5B%0A++++%7B%0A++++++++%22relation%22%3A+%5B%0A++++++++++++%22delegate_permission%2Fcommon.handle_all_urls%22%0A++++++++%5D,%0A++++++++%22target%22%3A+%7B%0A++++++++++++%22namespace%22%3A+%22android_app%22,%0A++++++++++++%22package_name%22%3A+%22com.example.app%22,%0A++++++++++++%22sha256_cert_fingerprints%22%3A+%5B%0A++++++++++++++++%22hash_of_app_certificate%22%0A++++++++++++%5D%0A++++++++%7D%0A++++%7D%0A%5D&ios=%7B%0A++++%22applinks%22%3A+%7B%0A++++++++%22apps%22%3A+%5B%5D,%0A++++++++%22details%22%3A+%5B%0A++++++++++++%7B%0A++++++++++++++++%22appID%22%3A+%22D3KQX62K1A.com.example.photoapp%22,%0A++++++++++++++++%22paths%22%3A+%5B%0A++++++++++++++++++++%22%2Falbums%22%0A++++++++++++++++%5D%0A++++++++++++%7D,%0A++++++++++++%7B%0A++++++++++++++++%22appID%22%3A+%22D3KQX62K1A.com.example.videoapp%22,%0A++++++++++++++++%22paths%22%3A+%5B%0A++++++++++++++++++++%22%2Fvideos%22%0A++++++++++++++++%5D%0A++++++++++++%7D%0A++++++++%5D%0A++++%7D%0A%7D&format=xml

Query parameters

   name = deep configuration domain_name
android = [
    {
        "relation": [
            "delegate_permission/common.handle_all_urls"
        ],
        "target": {
            "namespace": "android_app",
            "package_name": "com.example.app",
            "sha256_cert_fingerprints": [
                "hash_of_app_certificate"
            ]
        }
    }
]
    ios = {
    "applinks": {
        "apps": [],
        "details": [
            {
                "appID": "D3KQX62K1A.com.example.photoapp",
                "paths": [
                    "/albums"
                ]
            },
            {
                "appID": "D3KQX62K1A.com.example.videoapp",
                "paths": [
                    "/videos"
                ]
            }
        ]
    }
}
 format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>1234567890abcdef</id>  
    <name>deep configuration domain_name</name>  
    <android>[
    {
        "relation": [
            "delegate_permission/common.handle_all_urls"
        ],
        "target": {
            "namespace": "android_app",
            "package_name": "com.example.app",
            "sha256_cert_fingerprints": [
                "hash_of_app_certificate"
            ]
        }
    }
]</android>  
    <ios>{
    "applinks": {
        "apps": [],
        "details": [
            {
                "appID": "D3KQX62K1A.com.example.photoapp",
                "paths": [
                    "/albums"
                ]
            },
            {
                "appID": "D3KQX62K1A.com.example.videoapp",
                "paths": [
                    "/videos"
                ]
            }
        ]
    }
}</ios>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/deeplinks/add?name=deep+configuration+domain_name&android=%5B%0A++++%7B%0A++++++++%22relation%22%3A+%5B%0A++++++++++++%22delegate_permission%2Fcommon.handle_all_urls%22%0A++++++++%5D,%0A++++++++%22target%22%3A+%7B%0A++++++++++++%22namespace%22%3A+%22android_app%22,%0A++++++++++++%22package_name%22%3A+%22com.example.app%22,%0A++++++++++++%22sha256_cert_fingerprints%22%3A+%5B%0A++++++++++++++++%22hash_of_app_certificate%22%0A++++++++++++%5D%0A++++++++%7D%0A++++%7D%0A%5D&ios=%7B%0A++++%22applinks%22%3A+%7B%0A++++++++%22apps%22%3A+%5B%5D,%0A++++++++%22details%22%3A+%5B%0A++++++++++++%7B%0A++++++++++++++++%22appID%22%3A+%22D3KQX62K1A.com.example.photoapp%22,%0A++++++++++++++++%22paths%22%3A+%5B%0A++++++++++++++++++++%22%2Falbums%22%0A++++++++++++++++%5D%0A++++++++++++%7D,%0A++++++++++++%7B%0A++++++++++++++++%22appID%22%3A+%22D3KQX62K1A.com.example.videoapp%22,%0A++++++++++++++++%22paths%22%3A+%5B%0A++++++++++++++++++++%22%2Fvideos%22%0A++++++++++++++++%5D%0A++++++++++++%7D%0A++++++++%5D%0A++++%7D%0A%7D&format=txt

Query parameters

   name = deep configuration domain_name
android = [
    {
        "relation": [
            "delegate_permission/common.handle_all_urls"
        ],
        "target": {
            "namespace": "android_app",
            "package_name": "com.example.app",
            "sha256_cert_fingerprints": [
                "hash_of_app_certificate"
            ]
        }
    }
]
    ios = {
    "applinks": {
        "apps": [],
        "details": [
            {
                "appID": "D3KQX62K1A.com.example.photoapp",
                "paths": [
                    "/albums"
                ]
            },
            {
                "appID": "D3KQX62K1A.com.example.videoapp",
                "paths": [
                    "/videos"
                ]
            }
        ]
    }
}
 format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=1234567890abcdef
result_name=deep configuration domain_name
result_android=[    {        "relation": [            "delegate_permission/common.handle_all_urls"        ],        "target": {            "namespace": "android_app",            "package_name": "com.example.app",            "sha256_cert_fingerprints": [                "hash_of_app_certificate"            ]        }    }]
result_ios={    "applinks": {        "apps": [],        "details": [            {                "appID": "D3KQX62K1A.com.example.photoapp",                "paths": [                    "/albums"                ]            },            {                "appID": "D3KQX62K1A.com.example.videoapp",                "paths": [                    "/videos"                ]            }        ]    }}

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/deeplinks/add?name=deep+configuration+domain_name&android=%5B%0A++++%7B%0A++++++++%22relation%22%3A+%5B%0A++++++++++++%22delegate_permission%2Fcommon.handle_all_urls%22%0A++++++++%5D,%0A++++++++%22target%22%3A+%7B%0A++++++++++++%22namespace%22%3A+%22android_app%22,%0A++++++++++++%22package_name%22%3A+%22com.example.app%22,%0A++++++++++++%22sha256_cert_fingerprints%22%3A+%5B%0A++++++++++++++++%22hash_of_app_certificate%22%0A++++++++++++%5D%0A++++++++%7D%0A++++%7D%0A%5D&ios=%7B%0A++++%22applinks%22%3A+%7B%0A++++++++%22apps%22%3A+%5B%5D,%0A++++++++%22details%22%3A+%5B%0A++++++++++++%7B%0A++++++++++++++++%22appID%22%3A+%22D3KQX62K1A.com.example.photoapp%22,%0A++++++++++++++++%22paths%22%3A+%5B%0A++++++++++++++++++++%22%2Falbums%22%0A++++++++++++++++%5D%0A++++++++++++%7D,%0A++++++++++++%7B%0A++++++++++++++++%22appID%22%3A+%22D3KQX62K1A.com.example.videoapp%22,%0A++++++++++++++++%22paths%22%3A+%5B%0A++++++++++++++++++++%22%2Fvideos%22%0A++++++++++++++++%5D%0A++++++++++++%7D%0A++++++++%5D%0A++++%7D%0A%7D&format=plain

Query parameters

   name = deep configuration domain_name
android = [
    {
        "relation": [
            "delegate_permission/common.handle_all_urls"
        ],
        "target": {
            "namespace": "android_app",
            "package_name": "com.example.app",
            "sha256_cert_fingerprints": [
                "hash_of_app_certificate"
            ]
        }
    }
]
    ios = {
    "applinks": {
        "apps": [],
        "details": [
            {
                "appID": "D3KQX62K1A.com.example.photoapp",
                "paths": [
                    "/albums"
                ]
            },
            {
                "appID": "D3KQX62K1A.com.example.videoapp",
                "paths": [
                    "/videos"
                ]
            }
        ]
    }
}
 format = plain

Response

1234567890abcdef
deep configuration domain_name
[    {        "relation": [            "delegate_permission/common.handle_all_urls"        ],        "target": {            "namespace": "android_app",            "package_name": "com.example.app",            "sha256_cert_fingerprints": [                "hash_of_app_certificate"            ]        }    }]
{    "applinks": {        "apps": [],        "details": [            {                "appID": "D3KQX62K1A.com.example.photoapp",                "paths": [                    "/albums"                ]            },            {                "appID": "D3KQX62K1A.com.example.videoapp",                "paths": [                    "/videos"                ]            }        ]    }}
Required parameters
parameterdescription
nameSTRINGdomain_name of the deep link configuration
Optional parameters
parameterdescriptionmax length
androidSTRINGJSON configuration for Android (assetlinks.json)4000
iosSTRINGJSON configuration for iOS (apple-app-site-association)4000
Return values
parameterdescription
androidJSON configuration for Android (assetlinks.json)
idID of the deep link configuration
iosJSON configuration for iOS (apple-app-site-association)
namedomain_name of the deep link configuration

access: [READ]

This method returns the number of user's deep link configurations.

Example 1 (json)

Request

https://joturl.com/a/i1/domains/deeplinks/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 5
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/deeplinks/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>5</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/deeplinks/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=5

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/deeplinks/count?format=plain

Query parameters

format = plain

Response

5

Example 5 (json)

Request

https://joturl.com/a/i1/domains/deeplinks/count?search=test

Query parameters

search = test

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 3
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/domains/deeplinks/count?search=test&format=xml

Query parameters

search = test
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>3</count>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/domains/deeplinks/count?search=test&format=txt

Query parameters

search = test
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=3

Example 8 (plain)

Request

https://joturl.com/a/i1/domains/deeplinks/count?search=test&format=plain

Query parameters

search = test
format = plain

Response

3
Optional parameters
parameterdescription
searchSTRINGcount items by searching them
Return values
parameterdescription
countnumber of deep link configurations the user has access to (filtered by search if passed)

access: [WRITE]

Delete a deep link configuration for the user logged in.

Example 1 (json)

Request

https://joturl.com/a/i1/domains/deeplinks/delete?ids=10,200,3000

Query parameters

ids = 10,200,3000

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 3
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/deeplinks/delete?ids=10,200,3000&format=xml

Query parameters

   ids = 10,200,3000
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>3</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/deeplinks/delete?ids=10,200,3000&format=txt

Query parameters

   ids = 10,200,3000
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=3

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/deeplinks/delete?ids=10,200,3000&format=plain

Query parameters

   ids = 10,200,3000
format = plain

Response

3

Example 5 (json)

Request

https://joturl.com/a/i1/domains/deeplinks/delete?ids=4000,50000,100000

Query parameters

ids = 4000,50000,100000

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "ids": "50000,100000",
    "deleted": 1
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/domains/deeplinks/delete?ids=4000,50000,100000&format=xml

Query parameters

   ids = 4000,50000,100000
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <ids>50000,100000</ids>  
    <deleted>1</deleted>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/domains/deeplinks/delete?ids=4000,50000,100000&format=txt

Query parameters

   ids = 4000,50000,100000
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_ids=50000,100000
result_deleted=1

Example 8 (plain)

Request

https://joturl.com/a/i1/domains/deeplinks/delete?ids=4000,50000,100000&format=plain

Query parameters

   ids = 4000,50000,100000
format = plain

Response

50000,100000
1
Required parameters
parameterdescription
idsARRAY_OF_IDScomma separated list of domain IDs to be deleted
Return values
parameterdescription
deletednumber of deleted domains
ids[OPTIONAL] list of domain IDs whose delete has failed, this parameter is returned only when at least one delete error has occurred

access: [WRITE]

Edit a deep link configuration for the logged user.

Example 1 (json)

Request

https://joturl.com/a/i1/domains/deeplinks/edit?name=deep+configuration+domain_name&android=%5B%0A++++%7B%0A++++++++%22relation%22%3A+%5B%0A++++++++++++%22delegate_permission%2Fcommon.handle_all_urls%22%0A++++++++%5D,%0A++++++++%22target%22%3A+%7B%0A++++++++++++%22namespace%22%3A+%22android_app%22,%0A++++++++++++%22package_name%22%3A+%22com.example.app%22,%0A++++++++++++%22sha256_cert_fingerprints%22%3A+%5B%0A++++++++++++++++%22hash_of_app_certificate%22%0A++++++++++++%5D%0A++++++++%7D%0A++++%7D%0A%5D&ios=%7B%0A++++%22applinks%22%3A+%7B%0A++++++++%22apps%22%3A+%5B%5D,%0A++++++++%22details%22%3A+%5B%0A++++++++++++%7B%0A++++++++++++++++%22appID%22%3A+%22D3KQX62K1A.com.example.photoapp%22,%0A++++++++++++++++%22paths%22%3A+%5B%0A++++++++++++++++++++%22%2Falbums%22%0A++++++++++++++++%5D%0A++++++++++++%7D,%0A++++++++++++%7B%0A++++++++++++++++%22appID%22%3A+%22D3KQX62K1A.com.example.videoapp%22,%0A++++++++++++++++%22paths%22%3A+%5B%0A++++++++++++++++++++%22%2Fvideos%22%0A++++++++++++++++%5D%0A++++++++++++%7D%0A++++++++%5D%0A++++%7D%0A%7D

Query parameters

   name = deep configuration domain_name
android = [
    {
        "relation": [
            "delegate_permission/common.handle_all_urls"
        ],
        "target": {
            "namespace": "android_app",
            "package_name": "com.example.app",
            "sha256_cert_fingerprints": [
                "hash_of_app_certificate"
            ]
        }
    }
]
    ios = {
    "applinks": {
        "apps": [],
        "details": [
            {
                "appID": "D3KQX62K1A.com.example.photoapp",
                "paths": [
                    "/albums"
                ]
            },
            {
                "appID": "D3KQX62K1A.com.example.videoapp",
                "paths": [
                    "/videos"
                ]
            }
        ]
    }
}

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "1234567890abcdef",
    "name": "deep configuration domain_name",
    "android": "[
{
\"relation\": [
\"delegate_permission\/common.handle_all_urls\"
],
\"target\": {
\"namespace\": \"android_app\",
\"package_name\": \"com.example.app\",
\"sha256_cert_fingerprints\": [
\"hash_of_app_certificate\"
]
}
}
]"
, "ios": "{
\"applinks\": {
\"apps\": [],
\"details\": [
{
\"appID\": \"D3KQX62K1A.com.example.photoapp\",
\"paths\": [
\"\/albums\"
]
},
{
\"appID\": \"D3KQX62K1A.com.example.videoapp\",
\"paths\": [
\"\/videos\"
]
}
]
}
}"
} }

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/deeplinks/edit?name=deep+configuration+domain_name&android=%5B%0A++++%7B%0A++++++++%22relation%22%3A+%5B%0A++++++++++++%22delegate_permission%2Fcommon.handle_all_urls%22%0A++++++++%5D,%0A++++++++%22target%22%3A+%7B%0A++++++++++++%22namespace%22%3A+%22android_app%22,%0A++++++++++++%22package_name%22%3A+%22com.example.app%22,%0A++++++++++++%22sha256_cert_fingerprints%22%3A+%5B%0A++++++++++++++++%22hash_of_app_certificate%22%0A++++++++++++%5D%0A++++++++%7D%0A++++%7D%0A%5D&ios=%7B%0A++++%22applinks%22%3A+%7B%0A++++++++%22apps%22%3A+%5B%5D,%0A++++++++%22details%22%3A+%5B%0A++++++++++++%7B%0A++++++++++++++++%22appID%22%3A+%22D3KQX62K1A.com.example.photoapp%22,%0A++++++++++++++++%22paths%22%3A+%5B%0A++++++++++++++++++++%22%2Falbums%22%0A++++++++++++++++%5D%0A++++++++++++%7D,%0A++++++++++++%7B%0A++++++++++++++++%22appID%22%3A+%22D3KQX62K1A.com.example.videoapp%22,%0A++++++++++++++++%22paths%22%3A+%5B%0A++++++++++++++++++++%22%2Fvideos%22%0A++++++++++++++++%5D%0A++++++++++++%7D%0A++++++++%5D%0A++++%7D%0A%7D&format=xml

Query parameters

   name = deep configuration domain_name
android = [
    {
        "relation": [
            "delegate_permission/common.handle_all_urls"
        ],
        "target": {
            "namespace": "android_app",
            "package_name": "com.example.app",
            "sha256_cert_fingerprints": [
                "hash_of_app_certificate"
            ]
        }
    }
]
    ios = {
    "applinks": {
        "apps": [],
        "details": [
            {
                "appID": "D3KQX62K1A.com.example.photoapp",
                "paths": [
                    "/albums"
                ]
            },
            {
                "appID": "D3KQX62K1A.com.example.videoapp",
                "paths": [
                    "/videos"
                ]
            }
        ]
    }
}
 format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>1234567890abcdef</id>  
    <name>deep configuration domain_name</name>  
    <android>[
    {
        "relation": [
            "delegate_permission/common.handle_all_urls"
        ],
        "target": {
            "namespace": "android_app",
            "package_name": "com.example.app",
            "sha256_cert_fingerprints": [
                "hash_of_app_certificate"
            ]
        }
    }
]</android>  
    <ios>{
    "applinks": {
        "apps": [],
        "details": [
            {
                "appID": "D3KQX62K1A.com.example.photoapp",
                "paths": [
                    "/albums"
                ]
            },
            {
                "appID": "D3KQX62K1A.com.example.videoapp",
                "paths": [
                    "/videos"
                ]
            }
        ]
    }
}</ios>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/deeplinks/edit?name=deep+configuration+domain_name&android=%5B%0A++++%7B%0A++++++++%22relation%22%3A+%5B%0A++++++++++++%22delegate_permission%2Fcommon.handle_all_urls%22%0A++++++++%5D,%0A++++++++%22target%22%3A+%7B%0A++++++++++++%22namespace%22%3A+%22android_app%22,%0A++++++++++++%22package_name%22%3A+%22com.example.app%22,%0A++++++++++++%22sha256_cert_fingerprints%22%3A+%5B%0A++++++++++++++++%22hash_of_app_certificate%22%0A++++++++++++%5D%0A++++++++%7D%0A++++%7D%0A%5D&ios=%7B%0A++++%22applinks%22%3A+%7B%0A++++++++%22apps%22%3A+%5B%5D,%0A++++++++%22details%22%3A+%5B%0A++++++++++++%7B%0A++++++++++++++++%22appID%22%3A+%22D3KQX62K1A.com.example.photoapp%22,%0A++++++++++++++++%22paths%22%3A+%5B%0A++++++++++++++++++++%22%2Falbums%22%0A++++++++++++++++%5D%0A++++++++++++%7D,%0A++++++++++++%7B%0A++++++++++++++++%22appID%22%3A+%22D3KQX62K1A.com.example.videoapp%22,%0A++++++++++++++++%22paths%22%3A+%5B%0A++++++++++++++++++++%22%2Fvideos%22%0A++++++++++++++++%5D%0A++++++++++++%7D%0A++++++++%5D%0A++++%7D%0A%7D&format=txt

Query parameters

   name = deep configuration domain_name
android = [
    {
        "relation": [
            "delegate_permission/common.handle_all_urls"
        ],
        "target": {
            "namespace": "android_app",
            "package_name": "com.example.app",
            "sha256_cert_fingerprints": [
                "hash_of_app_certificate"
            ]
        }
    }
]
    ios = {
    "applinks": {
        "apps": [],
        "details": [
            {
                "appID": "D3KQX62K1A.com.example.photoapp",
                "paths": [
                    "/albums"
                ]
            },
            {
                "appID": "D3KQX62K1A.com.example.videoapp",
                "paths": [
                    "/videos"
                ]
            }
        ]
    }
}
 format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=1234567890abcdef
result_name=deep configuration domain_name
result_android=[    {        "relation": [            "delegate_permission/common.handle_all_urls"        ],        "target": {            "namespace": "android_app",            "package_name": "com.example.app",            "sha256_cert_fingerprints": [                "hash_of_app_certificate"            ]        }    }]
result_ios={    "applinks": {        "apps": [],        "details": [            {                "appID": "D3KQX62K1A.com.example.photoapp",                "paths": [                    "/albums"                ]            },            {                "appID": "D3KQX62K1A.com.example.videoapp",                "paths": [                    "/videos"                ]            }        ]    }}

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/deeplinks/edit?name=deep+configuration+domain_name&android=%5B%0A++++%7B%0A++++++++%22relation%22%3A+%5B%0A++++++++++++%22delegate_permission%2Fcommon.handle_all_urls%22%0A++++++++%5D,%0A++++++++%22target%22%3A+%7B%0A++++++++++++%22namespace%22%3A+%22android_app%22,%0A++++++++++++%22package_name%22%3A+%22com.example.app%22,%0A++++++++++++%22sha256_cert_fingerprints%22%3A+%5B%0A++++++++++++++++%22hash_of_app_certificate%22%0A++++++++++++%5D%0A++++++++%7D%0A++++%7D%0A%5D&ios=%7B%0A++++%22applinks%22%3A+%7B%0A++++++++%22apps%22%3A+%5B%5D,%0A++++++++%22details%22%3A+%5B%0A++++++++++++%7B%0A++++++++++++++++%22appID%22%3A+%22D3KQX62K1A.com.example.photoapp%22,%0A++++++++++++++++%22paths%22%3A+%5B%0A++++++++++++++++++++%22%2Falbums%22%0A++++++++++++++++%5D%0A++++++++++++%7D,%0A++++++++++++%7B%0A++++++++++++++++%22appID%22%3A+%22D3KQX62K1A.com.example.videoapp%22,%0A++++++++++++++++%22paths%22%3A+%5B%0A++++++++++++++++++++%22%2Fvideos%22%0A++++++++++++++++%5D%0A++++++++++++%7D%0A++++++++%5D%0A++++%7D%0A%7D&format=plain

Query parameters

   name = deep configuration domain_name
android = [
    {
        "relation": [
            "delegate_permission/common.handle_all_urls"
        ],
        "target": {
            "namespace": "android_app",
            "package_name": "com.example.app",
            "sha256_cert_fingerprints": [
                "hash_of_app_certificate"
            ]
        }
    }
]
    ios = {
    "applinks": {
        "apps": [],
        "details": [
            {
                "appID": "D3KQX62K1A.com.example.photoapp",
                "paths": [
                    "/albums"
                ]
            },
            {
                "appID": "D3KQX62K1A.com.example.videoapp",
                "paths": [
                    "/videos"
                ]
            }
        ]
    }
}
 format = plain

Response

1234567890abcdef
deep configuration domain_name
[    {        "relation": [            "delegate_permission/common.handle_all_urls"        ],        "target": {            "namespace": "android_app",            "package_name": "com.example.app",            "sha256_cert_fingerprints": [                "hash_of_app_certificate"            ]        }    }]
{    "applinks": {        "apps": [],        "details": [            {                "appID": "D3KQX62K1A.com.example.photoapp",                "paths": [                    "/albums"                ]            },            {                "appID": "D3KQX62K1A.com.example.videoapp",                "paths": [                    "/videos"                ]            }        ]    }}
Required parameters
parameterdescription
idIDID of the deep link configuration
Optional parameters
parameterdescriptionmax length
androidSTRINGJSON configuration for Android (assetlinks.json)4000
iosSTRINGJSON configuration for iOS (apple-app-site-association)4000
nameSTRINGdomain_name of the deep link configuration
Return values
parameterdescription
androidJSON configuration for Android (assetlinks.json)
idID of the deep link configuration
iosJSON configuration for iOS (apple-app-site-association)
namedomain_name of the deep link configuration

access: [READ]

This method returns information on a deep link configuration.

Example 1 (json)

Request

https://joturl.com/a/i1/domains/deeplinks/info?id=1234567890abcdef

Query parameters

id = 1234567890abcdef

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "1234567890abcdef",
    "name": "this is my domain_name",
    "android": "[
{
\"relation\": [
\"delegate_permission\/common.handle_all_urls\"
],
\"target\": {
\"namespace\": \"android_app\",
\"package_name\": \"com.example.app\",
\"sha256_cert_fingerprints\": [
\"hash_of_app_certificate\"
]
}
}
]"
, "ios": "{
\"applinks\": {
\"apps\": [],
\"details\": [
{
\"appID\": \"D3KQX62K1A.com.example.photoapp\",
\"paths\": [
\"\/albums\"
]
},
{
\"appID\": \"D3KQX62K1A.com.example.videoapp\",
\"paths\": [
\"\/videos\"
]
}
]
}
}"
} }

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/deeplinks/info?id=1234567890abcdef&format=xml

Query parameters

    id = 1234567890abcdef
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>1234567890abcdef</id>  
    <name>this is my domain_name</name>  
    <android>[
    {
        "relation": [
            "delegate_permission/common.handle_all_urls"
        ],
        "target": {
            "namespace": "android_app",
            "package_name": "com.example.app",
            "sha256_cert_fingerprints": [
                "hash_of_app_certificate"
            ]
        }
    }
]</android>  
    <ios>{
    "applinks": {
        "apps": [],
        "details": [
            {
                "appID": "D3KQX62K1A.com.example.photoapp",
                "paths": [
                    "/albums"
                ]
            },
            {
                "appID": "D3KQX62K1A.com.example.videoapp",
                "paths": [
                    "/videos"
                ]
            }
        ]
    }
}</ios>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/deeplinks/info?id=1234567890abcdef&format=txt

Query parameters

    id = 1234567890abcdef
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=1234567890abcdef
result_name=this is my domain_name
result_android=[    {        "relation": [            "delegate_permission/common.handle_all_urls"        ],        "target": {            "namespace": "android_app",            "package_name": "com.example.app",            "sha256_cert_fingerprints": [                "hash_of_app_certificate"            ]        }    }]
result_ios={    "applinks": {        "apps": [],        "details": [            {                "appID": "D3KQX62K1A.com.example.photoapp",                "paths": [                    "/albums"                ]            },            {                "appID": "D3KQX62K1A.com.example.videoapp",                "paths": [                    "/videos"                ]            }        ]    }}

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/deeplinks/info?id=1234567890abcdef&format=plain

Query parameters

    id = 1234567890abcdef
format = plain

Response

1234567890abcdef
this is my domain_name
[    {        "relation": [            "delegate_permission/common.handle_all_urls"        ],        "target": {            "namespace": "android_app",            "package_name": "com.example.app",            "sha256_cert_fingerprints": [                "hash_of_app_certificate"            ]        }    }]
{    "applinks": {        "apps": [],        "details": [            {                "appID": "D3KQX62K1A.com.example.photoapp",                "paths": [                    "/albums"                ]            },            {                "appID": "D3KQX62K1A.com.example.videoapp",                "paths": [                    "/videos"                ]            }        ]    }}
Required parameters
parameterdescription
idIDID of the deep link configuration
Return values
parameterdescription
androidJSON configuration for Android (assetlinks.json)
idID of the deep link configuration
iosJSON configuration for iOS (apple-app-site-association)
namedomain_name of the deep link configuration

access: [READ]

This method returns a list of deeplink configurations.

Example 1 (json)

Request

https://joturl.com/a/i1/domains/deeplinks/list

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 1,
    "data": {
      "id": "1234567890abcdef",
      "name": "this is my domain_name",
      "android": "[{\"relation\":[\"delegate_permission\/common.handle_all_urls\"],\"target\":{\"namespace\":\"android_app\",\"package_name\":\"com.example.app\",\"sha256_cert_fingerprints\":[\"hash_of_app_certificate\"]}}]",
      "ios": "{\"applinks\":{\"apps\":[],\"details\":[{\"appID\":\"D3KQX62K1A.com.example.photoapp\",\"paths\":[\"\/albums\"]},{\"appID\":\"D3KQX62K1A.com.example.videoapp\",\"paths\":[\"\/videos\"]}]}}"
    },
    "android": "",
    "ios": ""
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/deeplinks/list?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>1</count>  
    <data>
      <id>1234567890abcdef</id>  
      <name>this is my domain_name</name>  
      <android>[{"relation":["delegate_permission/common.handle_all_urls"],"target":{"namespace":"android_app","package_name":"com.example.app","sha256_cert_fingerprints":["hash_of_app_certificate"]}}]</android>  
      <ios>{"applinks":{"apps":[],"details":[{"appID":"D3KQX62K1A.com.example.photoapp","paths":["/albums"]},{"appID":"D3KQX62K1A.com.example.videoapp","paths":["/videos"]}]}}</ios>  
    </data>  
    <android></android>  
    <ios></ios>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/deeplinks/list?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=1
result_data_id=1234567890abcdef
result_data_name=this is my domain_name
result_data_android=[{"relation":["delegate_permission/common.handle_all_urls"],"target":{"namespace":"android_app","package_name":"com.example.app","sha256_cert_fingerprints":["hash_of_app_certificate"]}}]
result_data_ios={"applinks":{"apps":[],"details":[{"appID":"D3KQX62K1A.com.example.photoapp","paths":["/albums"]},{"appID":"D3KQX62K1A.com.example.videoapp","paths":["/videos"]}]}}
result_android=
result_ios=

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/deeplinks/list?format=plain

Query parameters

format = plain

Response

1
1234567890abcdef
this is my domain_name
[{"relation":["delegate_permission/common.handle_all_urls"],"target":{"namespace":"android_app","package_name":"com.example.app","sha256_cert_fingerprints":["hash_of_app_certificate"]}}]
{"applinks":{"apps":[],"details":[{"appID":"D3KQX62K1A.com.example.photoapp","paths":["/albums"]},{"appID":"D3KQX62K1A.com.example.videoapp","paths":["/videos"]}]}}


Optional parameters
parameterdescription
lengthINTEGERextracts this number of items (maxmimum allowed: 100)
orderbyARRAYorders items by field, available fields: start, length, search, orderby, sort, format, callback
searchSTRINGfilters items to be extracted by searching them
sortSTRINGsorts items in ascending (ASC) or descending (DESC) order
startINTEGERstarts to extract items from this position
Return values
parameterdescription
counttotal number of deep link configurations
dataarray containing information on deep link configurations the user has access to

/domains/delete

access: [WRITE]

Delete a domain for the user logged in.

Example 1 (json)

Request

https://joturl.com/a/i1/domains/delete?ids=6512bd43d9caa6e02c990b0a82652dca,757b505cfd34c64c85ca5b5690ee5293,908c9a564a86426585b29f5335b619bc

Query parameters

ids = 6512bd43d9caa6e02c990b0a82652dca,757b505cfd34c64c85ca5b5690ee5293,908c9a564a86426585b29f5335b619bc

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 3
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/delete?ids=6512bd43d9caa6e02c990b0a82652dca,757b505cfd34c64c85ca5b5690ee5293,908c9a564a86426585b29f5335b619bc&format=xml

Query parameters

   ids = 6512bd43d9caa6e02c990b0a82652dca,757b505cfd34c64c85ca5b5690ee5293,908c9a564a86426585b29f5335b619bc
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>3</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/delete?ids=6512bd43d9caa6e02c990b0a82652dca,757b505cfd34c64c85ca5b5690ee5293,908c9a564a86426585b29f5335b619bc&format=txt

Query parameters

   ids = 6512bd43d9caa6e02c990b0a82652dca,757b505cfd34c64c85ca5b5690ee5293,908c9a564a86426585b29f5335b619bc
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=3

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/delete?ids=6512bd43d9caa6e02c990b0a82652dca,757b505cfd34c64c85ca5b5690ee5293,908c9a564a86426585b29f5335b619bc&format=plain

Query parameters

   ids = 6512bd43d9caa6e02c990b0a82652dca,757b505cfd34c64c85ca5b5690ee5293,908c9a564a86426585b29f5335b619bc
format = plain

Response

3

Example 5 (json)

Request

https://joturl.com/a/i1/domains/delete?ids=ffc58105bf6f8a91aba0fa2d99e6f106,334146de1b9346272cb013adf1a35aea,e2a6a1ace352668000aed191a817d143

Query parameters

ids = ffc58105bf6f8a91aba0fa2d99e6f106,334146de1b9346272cb013adf1a35aea,e2a6a1ace352668000aed191a817d143

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "ids": "334146de1b9346272cb013adf1a35aea,e2a6a1ace352668000aed191a817d143",
    "deleted": 1
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/domains/delete?ids=ffc58105bf6f8a91aba0fa2d99e6f106,334146de1b9346272cb013adf1a35aea,e2a6a1ace352668000aed191a817d143&format=xml

Query parameters

   ids = ffc58105bf6f8a91aba0fa2d99e6f106,334146de1b9346272cb013adf1a35aea,e2a6a1ace352668000aed191a817d143
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <ids>334146de1b9346272cb013adf1a35aea,e2a6a1ace352668000aed191a817d143</ids>  
    <deleted>1</deleted>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/domains/delete?ids=ffc58105bf6f8a91aba0fa2d99e6f106,334146de1b9346272cb013adf1a35aea,e2a6a1ace352668000aed191a817d143&format=txt

Query parameters

   ids = ffc58105bf6f8a91aba0fa2d99e6f106,334146de1b9346272cb013adf1a35aea,e2a6a1ace352668000aed191a817d143
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_ids=334146de1b9346272cb013adf1a35aea,e2a6a1ace352668000aed191a817d143
result_deleted=1

Example 8 (plain)

Request

https://joturl.com/a/i1/domains/delete?ids=ffc58105bf6f8a91aba0fa2d99e6f106,334146de1b9346272cb013adf1a35aea,e2a6a1ace352668000aed191a817d143&format=plain

Query parameters

   ids = ffc58105bf6f8a91aba0fa2d99e6f106,334146de1b9346272cb013adf1a35aea,e2a6a1ace352668000aed191a817d143
format = plain

Response

334146de1b9346272cb013adf1a35aea,e2a6a1ace352668000aed191a817d143
1
Required parameters
parameterdescription
idsARRAY_OF_IDScomma separated list of domain IDs to be deleted, max number of IDs in the list: 100
Return values
parameterdescription
deletednumber of deleted domains
ids[OPTIONAL] list of domain IDs whose delete has failed, this parameter is returned only when at least one delete error has occurred

/domains/edit

access: [WRITE]

Edit a domain for logged user.

Example 1 (json)

Request

https://joturl.com/a/i1/domains/edit?id=1234567890abcdef&force_https=0&host=domain.ext&nickname=my+domain+nickname&redirect_url=https%3A%2F%2Fredirect.users.to%2F&deeplink_id=&domain_domains_deeplink_name=&input=name_of_the_form_field_that_contains_image_data

Query parameters

                          id = 1234567890abcdef
                 force_https = 0
                        host = domain.ext
                    nickname = my domain nickname
                redirect_url = https://redirect.users.to/
                 deeplink_id = 
domain_domains_deeplink_name = 
                       input = name_of_the_form_field_that_contains_image_data

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "1234567890abcdef",
    "force_https": "0",
    "host": "domain.ext",
    "nickname": "my domain nickname",
    "redirect_url": "https:\/\/redirect.users.to\/",
    "logo": "data:image\/gif;base64,R0lGODlhAQABAIAAAAAAAP\/\/\/yH5BAEAAAAALAAAAAABAAEAAAIBRAA7",
    "deeplink_id": "",
    "domain_domains_deeplink_name": ""
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/edit?id=1234567890abcdef&force_https=0&host=domain.ext&nickname=my+domain+nickname&redirect_url=https%3A%2F%2Fredirect.users.to%2F&deeplink_id=&domain_domains_deeplink_name=&input=name_of_the_form_field_that_contains_image_data&format=xml

Query parameters

                          id = 1234567890abcdef
                 force_https = 0
                        host = domain.ext
                    nickname = my domain nickname
                redirect_url = https://redirect.users.to/
                 deeplink_id = 
domain_domains_deeplink_name = 
                       input = name_of_the_form_field_that_contains_image_data
                      format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>1234567890abcdef</id>  
    <force_https>0</force_https>  
    <host>domain.ext</host>  
    <nickname>my domain nickname</nickname>  
    <redirect_url>https://redirect.users.to/</redirect_url>  
    <logo>data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7</logo>  
    <deeplink_id></deeplink_id>  
    <domain_domains_deeplink_name></domain_domains_deeplink_name>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/edit?id=1234567890abcdef&force_https=0&host=domain.ext&nickname=my+domain+nickname&redirect_url=https%3A%2F%2Fredirect.users.to%2F&deeplink_id=&domain_domains_deeplink_name=&input=name_of_the_form_field_that_contains_image_data&format=txt

Query parameters

                          id = 1234567890abcdef
                 force_https = 0
                        host = domain.ext
                    nickname = my domain nickname
                redirect_url = https://redirect.users.to/
                 deeplink_id = 
domain_domains_deeplink_name = 
                       input = name_of_the_form_field_that_contains_image_data
                      format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=1234567890abcdef
result_force_https=0
result_host=domain.ext
result_nickname=my domain nickname
result_redirect_url=https://redirect.users.to/
result_logo=data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7
result_deeplink_id=
result_domain_domains_deeplink_name=

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/edit?id=1234567890abcdef&force_https=0&host=domain.ext&nickname=my+domain+nickname&redirect_url=https%3A%2F%2Fredirect.users.to%2F&deeplink_id=&domain_domains_deeplink_name=&input=name_of_the_form_field_that_contains_image_data&format=plain

Query parameters

                          id = 1234567890abcdef
                 force_https = 0
                        host = domain.ext
                    nickname = my domain nickname
                redirect_url = https://redirect.users.to/
                 deeplink_id = 
domain_domains_deeplink_name = 
                       input = name_of_the_form_field_that_contains_image_data
                      format = plain

Response

1234567890abcdef
0
domain.ext
my domain nickname
https://redirect.users.to/
data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7


Required parameters
parameterdescription
idIDID of the domain to edit
Optional parameters
parameterdescriptionmax length
confirm_host_changeBOOLEANmust be 1 if host is passed to confirm the intention to change the domain, its value is ignored if host is not passed
deeplink_idIDID of the deep link configuration
favicon_urlSTRINGthe default favicon URL for the branded domain (to avoid securiy issues it must be HTTPS)4000
forceBOOLEAN1 to disable security checks, 0 otherwise. This parameter is ignored if host is not passed or if force_https = 1
force_httpsBOOLEAN1 to force HTTPS on HTTP requests, 0 otherwise (this flag takes effect only if a valid SSL certificate is associated with the domain)
hostSTRINGthe new domain (e.g., new.domain.ext), changing the domain impacts all tracking links to which it is associated, tracking links with the old domain will stop working; additionally, the change may take up to 24 hours before it actually takes effect and any SSL certificates associated with the old domain will be invalidated850
inputSTRINGname of the HTML form field that contains image data for the logo (max dimensions 120px x 50px, max size 150kB), see notes for details
nicknameSTRINGthe domain nickname50
redirect_urlSTRINGthe default destination URL where to redirect when a user types the domain without any alias (or an invalid alias)4000
robots_txtSTRINGthe robots.txt content to serve for the domain, when robots_txt = :NONE: requests to robots.txt will return a 404 error, if empty the following robots.txt will be served:
user-agent: *
disallow: /
4000

NOTES: The parameter input contains the name of the field of the HTML form that is used to send logo data to this method. Form must have enctype = "multipart/form-data" and method = "post".

<form 
    action="/a/i1/domains/edit" 
    method="post" 
    enctype="multipart/form-data">

    <input name="input" value="logo" type="hidden"/>

    [other form fields]

    <input name="logo" type="file"/>    

</form>
Return values
parameterdescription
deeplink_idID of the deep link configuration
deeplink_namename of the associated deep link configuration
favicon_urldefault favicon URL
force_https1 if the HTTPS is forced for the domain, 0 otherwise (this flag takes effect only if a valid SSL certificate is associated with the domain)
hostthe domain (e.g., domain.ext)
idID of the domain
logodefault logo for the domain (base64 encoded)
nicknamethe domain nickname
redirect_urldefault redirect URL
robots_txtthe robots.txt content to serve for the domain

/domains/info

access: [READ]

This method returns information on a domain, the returned information are that passed in the fields param (a comma separated list).

Example 1 (json)

Request

https://joturl.com/a/i1/domains/info?id=123145155&fields=deeplink_id,host,for_trials,force_https,id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,deeplink_name,is_owner,is_default,is_shared

Query parameters

    id = 123145155
fields = deeplink_id,host,for_trials,force_https,id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,deeplink_name,is_owner,is_default,is_shared

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "host": "domain.ext",
    "id": "7155502b34434f6a4d52396464684d3874442b454b773d3d",
    "aliases": [
      "domainext"
    ],
    "logo": "",
    "redirect_url": "",
    "favicon_url": "",
    "is_owner": 1,
    "is_default": 1,
    "is_shared": 0,
    "for_trials": 0
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/info?id=123145155&fields=deeplink_id,host,for_trials,force_https,id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,deeplink_name,is_owner,is_default,is_shared&format=xml

Query parameters

    id = 123145155
fields = deeplink_id,host,for_trials,force_https,id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,deeplink_name,is_owner,is_default,is_shared
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <host>domain.ext</host>  
    <id>7155502b34434f6a4d52396464684d3874442b454b773d3d</id>  
    <aliases>
      <i0>domainext</i0>  
    </aliases>  
    <logo></logo>  
    <redirect_url></redirect_url>  
    <favicon_url></favicon_url>  
    <is_owner>1</is_owner>  
    <is_default>1</is_default>  
    <is_shared>0</is_shared>  
    <for_trials>0</for_trials>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/info?id=123145155&fields=deeplink_id,host,for_trials,force_https,id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,deeplink_name,is_owner,is_default,is_shared&format=txt

Query parameters

    id = 123145155
fields = deeplink_id,host,for_trials,force_https,id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,deeplink_name,is_owner,is_default,is_shared
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_host=domain.ext
result_id=7155502b34434f6a4d52396464684d3874442b454b773d3d
result_aliases_0=domainext
result_logo=
result_redirect_url=
result_favicon_url=
result_is_owner=1
result_is_default=1
result_is_shared=0
result_for_trials=0

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/info?id=123145155&fields=deeplink_id,host,for_trials,force_https,id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,deeplink_name,is_owner,is_default,is_shared&format=plain

Query parameters

    id = 123145155
fields = deeplink_id,host,for_trials,force_https,id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,deeplink_name,is_owner,is_default,is_shared
format = plain

Response

domain.ext
7155502b34434f6a4d52396464684d3874442b454b773d3d
domainext



1
1
0
0
Required parameters
parameterdescription
fieldsARRAYcomma separated list of fields to return, available fields: deeplink_id, host, for_trials, force_https, id, aliases, nickname, logo, redirect_url, favicon_url, robots_txt, deeplink_name, is_owner, is_default, is_shared
idIDID of the domain
Return values
parameterdescription
aliases[OPTIONAL] array containing aliases of the domain, i.e., equivalent domains, returned only if aliases is passed in fields
deeplink_id[OPTIONAL] ID of the deep link configuration, returned only if deeplink_id is passed in fields
deeplink_name[OPTIONAL] ID of the deep link configuration, returned only if deeplink_name is passed in fields
favicon_url[OPTIONAL] default favicon URL, returned only if favicon_url is passed in fields
for_trials[OPTIONAL] 1 if the domain is reserved to trial plans, 0 otherwise
force_https[OPTIONAL] 1 if the "force HTTPS" flag is enabled for the domain, 0 otherwise; returned only if force_https is passed in fields
has_https[OPTIONAL] 1 if the domain has a valid SSL certificate, 0 otherwise, returned only if has_https is passed in fields
host[OPTIONAL] domain (e.g., domain.ext), returned only if host is passed in fields
id[OPTIONAL] ID of the domain, returned only if id is passed in fields
is_default[OPTIONAL] 1 if the domain is the default domain set in user's settings, 0 otherwise, returned only if is_default is passed in fields
is_owner[OPTIONAL] 1 if the logged user is owner of the domain, 0 otherwise, returned only if is_owner is passed in fields
is_shared[OPTIONAL] 1 if the domain is shared among all users, 0 otherwise, returned only if is_shared is passed in fields
logo[OPTIONAL] default logo (base64 encoded), returned only if logo is passed in fields
nickname[OPTIONAL] the domain nickname
redirect_url[OPTIONAL] default redirect URL, returned only if redirect_url is passed in fields
robots_txt[OPTIONAL] robots.txt configuration, see i1/domains/add for details

/domains/list

access: [READ]

This method returns a list of domains's data, specified in a comma separated input called fields.

Example 1 (json)

Request

https://joturl.com/a/i1/domains/list?fields=deeplink_id,host,for_trials,force_https,id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,deeplink_name,is_owner,is_default,is_shared,has_https,count

Query parameters

fields = deeplink_id,host,for_trials,force_https,id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,deeplink_name,is_owner,is_default,is_shared,has_https,count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": [
      {
        "host": "domain.ext",
        "id": "7155502b34434f6a4d52396464684d3874442b454b773d3d",
        "aliases": [
          "domainext"
        ],
        "logo": "",
        "redirect_url": "",
        "favicon_url": "",
        "is_owner": 1,
        "is_default": 1
      },
      {
        "host": "global.domain",
        "id": "15135ea",
        "aliases": [
          "globaldomain"
        ],
        "logo": "",
        "redirect_url": "https:\/\/www.redirect.to\/",
        "favicon_url": "",
        "is_owner": 0,
        "is_default": 0
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/list?fields=deeplink_id,host,for_trials,force_https,id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,deeplink_name,is_owner,is_default,is_shared,has_https,count&format=xml

Query parameters

fields = deeplink_id,host,for_trials,force_https,id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,deeplink_name,is_owner,is_default,is_shared,has_https,count
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <i0>
        <host>domain.ext</host>  
        <id>7155502b34434f6a4d52396464684d3874442b454b773d3d</id>  
        <aliases>
          <i0>domainext</i0>  
        </aliases>  
        <logo></logo>  
        <redirect_url></redirect_url>  
        <favicon_url></favicon_url>  
        <is_owner>1</is_owner>  
        <is_default>1</is_default>  
      </i0>  
      <i1>
        <host>global.domain</host>  
        <id>15135ea</id>  
        <aliases>
          <i0>globaldomain</i0>  
        </aliases>  
        <logo></logo>  
        <redirect_url>https://www.redirect.to/</redirect_url>  
        <favicon_url></favicon_url>  
        <is_owner>0</is_owner>  
        <is_default>0</is_default>  
      </i1>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/list?fields=deeplink_id,host,for_trials,force_https,id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,deeplink_name,is_owner,is_default,is_shared,has_https,count&format=txt

Query parameters

fields = deeplink_id,host,for_trials,force_https,id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,deeplink_name,is_owner,is_default,is_shared,has_https,count
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_0_host=domain.ext
result_data_0_id=7155502b34434f6a4d52396464684d3874442b454b773d3d
result_data_0_aliases_0=domainext
result_data_0_logo=
result_data_0_redirect_url=
result_data_0_favicon_url=
result_data_0_is_owner=1
result_data_0_is_default=1
result_data_1_host=global.domain
result_data_1_id=15135ea
result_data_1_aliases_0=globaldomain
result_data_1_logo=
result_data_1_redirect_url=https://www.redirect.to/
result_data_1_favicon_url=
result_data_1_is_owner=0
result_data_1_is_default=0

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/list?fields=deeplink_id,host,for_trials,force_https,id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,deeplink_name,is_owner,is_default,is_shared,has_https,count&format=plain

Query parameters

fields = deeplink_id,host,for_trials,force_https,id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,deeplink_name,is_owner,is_default,is_shared,has_https,count
format = plain

Response

domain.ext
7155502b34434f6a4d52396464684d3874442b454b773d3d
domainext



1
1
global.domain
15135ea
globaldomain

https://www.redirect.to/

0
0

Example 5 (json)

Request

https://joturl.com/a/i1/domains/list?is_owner=1&fields=deeplink_id,host,for_trials,force_https,id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,deeplink_name,is_owner,is_default,is_shared,has_https,count

Query parameters

is_owner = 1
  fields = deeplink_id,host,for_trials,force_https,id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,deeplink_name,is_owner,is_default,is_shared,has_https,count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": [
      {
        "host": "domain.ext",
        "id": "7155502b34434f6a4d52396464684d3874442b454b773d3d",
        "aliases": [
          "domainext"
        ],
        "logo": "",
        "redirect_url": "",
        "favicon_url": "",
        "is_owner": 1,
        "is_default": 1
      }
    ]
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/domains/list?is_owner=1&fields=deeplink_id,host,for_trials,force_https,id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,deeplink_name,is_owner,is_default,is_shared,has_https,count&format=xml

Query parameters

is_owner = 1
  fields = deeplink_id,host,for_trials,force_https,id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,deeplink_name,is_owner,is_default,is_shared,has_https,count
  format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <i0>
        <host>domain.ext</host>  
        <id>7155502b34434f6a4d52396464684d3874442b454b773d3d</id>  
        <aliases>
          <i0>domainext</i0>  
        </aliases>  
        <logo></logo>  
        <redirect_url></redirect_url>  
        <favicon_url></favicon_url>  
        <is_owner>1</is_owner>  
        <is_default>1</is_default>  
      </i0>  
    </data>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/domains/list?is_owner=1&fields=deeplink_id,host,for_trials,force_https,id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,deeplink_name,is_owner,is_default,is_shared,has_https,count&format=txt

Query parameters

is_owner = 1
  fields = deeplink_id,host,for_trials,force_https,id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,deeplink_name,is_owner,is_default,is_shared,has_https,count
  format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_0_host=domain.ext
result_data_0_id=7155502b34434f6a4d52396464684d3874442b454b773d3d
result_data_0_aliases_0=domainext
result_data_0_logo=
result_data_0_redirect_url=
result_data_0_favicon_url=
result_data_0_is_owner=1
result_data_0_is_default=1

Example 8 (plain)

Request

https://joturl.com/a/i1/domains/list?is_owner=1&fields=deeplink_id,host,for_trials,force_https,id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,deeplink_name,is_owner,is_default,is_shared,has_https,count&format=plain

Query parameters

is_owner = 1
  fields = deeplink_id,host,for_trials,force_https,id,aliases,nickname,logo,redirect_url,favicon_url,robots_txt,deeplink_name,is_owner,is_default,is_shared,has_https,count
  format = plain

Response

domain.ext
7155502b34434f6a4d52396464684d3874442b454b773d3d
domainext



1
1
Required parameters
parameterdescription
fieldsARRAYcomma separated list of fields to return, available fields: deeplink_id, host, for_trials, force_https, id, aliases, nickname, logo, redirect_url, favicon_url, robots_txt, deeplink_name, is_owner, is_default, is_shared, has_https, count
Optional parameters
parameterdescription
is_defaultBOOLEANif 1 this method returns the default domain and all shared domains, if 0 all domains are returned
is_ownerBOOLEANif 1 this method returns only domains owned by the logged user, if 0 it returns only shared domains
lengthINTEGERextracts this number of items (maxmimum allowed: 100)
orderbyARRAYorders items by field, available fields: deeplink_id, host, for_trials, force_https, id, aliases, nickname, logo, redirect_url, favicon_url, robots_txt, deeplink_name, is_owner, is_default, is_shared, has_https, count
searchSTRINGfilters items to be extracted by searching them
sortSTRINGsorts items in ascending (ASC) or descending (DESC) order
startINTEGERstarts to extract items from this position
Return values
parameterdescription
count[OPTIONAL] total number of domains, returned only if count is passed in fields
dataarray containing required information on domains the user has access to

/domains/property

access: [READ]

This method returns the limits for a domain logo.

Example 1 (json)

Request

https://joturl.com/a/i1/domains/property

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "max_size": 153600,
    "max_width": 120,
    "max_height": 50,
    "allowed_types": [
      "image\/gif",
      "image\/jpeg",
      "image\/jpg",
      "image\/pjpeg",
      "image\/x-png",
      "image\/png"
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/domains/property?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <max_size>153600</max_size>  
    <max_width>120</max_width>  
    <max_height>50</max_height>  
    <allowed_types>
      <i0>image/gif</i0>  
      <i1>image/jpeg</i1>  
      <i2>image/jpg</i2>  
      <i3>image/pjpeg</i3>  
      <i4>image/x-png</i4>  
      <i5>image/png</i5>  
    </allowed_types>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/domains/property?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_max_size=153600
result_max_width=120
result_max_height=50
result_allowed_types_0=image/gif
result_allowed_types_1=image/jpeg
result_allowed_types_2=image/jpg
result_allowed_types_3=image/pjpeg
result_allowed_types_4=image/x-png
result_allowed_types_5=image/png

Example 4 (plain)

Request

https://joturl.com/a/i1/domains/property?format=plain

Query parameters

format = plain

Response

153600
120
50
image/gif
image/jpeg
image/jpg
image/pjpeg
image/x-png
image/png
Return values
parameterdescription
allowed_typesarray of allowed image types (mime types)
max_heightmaximum allowed height for the logo (pixels)
max_sizemaximum allowed size for the logo (bytes)
max_widthmaximum allowed width for the logo (pixels)

/gdprs

/gdprs/add

access: [WRITE]

This method adds a new GDPR template.

Example 1 (json)

Request

https://joturl.com/a/i1/gdprs/add?company=JotUrl&home_link=https%3A%2F%2Fwww.joturl.com%2F&tos_link=https%3A%2F%2Fwww.joturl.com%2Fterms-of-service%2F

Query parameters

  company = JotUrl
home_link = https://www.joturl.com/
 tos_link = https://www.joturl.com/terms-of-service/

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "company": "JotUrl",
    "home_link": "https:\/\/www.joturl.com\/",
    "tos_link": "https:\/\/www.joturl.com\/terms-of-service\/",
    "id": "5dcb2cf8708302538859720db35ef523",
    "notes": "",
    "is_default": 0,
    "show_refuse_button": 0,
    "custom_translations": null
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/gdprs/add?company=JotUrl&home_link=https%3A%2F%2Fwww.joturl.com%2F&tos_link=https%3A%2F%2Fwww.joturl.com%2Fterms-of-service%2F&format=xml

Query parameters

  company = JotUrl
home_link = https://www.joturl.com/
 tos_link = https://www.joturl.com/terms-of-service/
   format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <company>JotUrl</company>  
    <home_link>https://www.joturl.com/</home_link>  
    <tos_link>https://www.joturl.com/terms-of-service/</tos_link>  
    <id>5dcb2cf8708302538859720db35ef523</id>  
    <notes></notes>  
    <is_default>0</is_default>  
    <show_refuse_button>0</show_refuse_button>  
    <custom_translations></custom_translations>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/gdprs/add?company=JotUrl&home_link=https%3A%2F%2Fwww.joturl.com%2F&tos_link=https%3A%2F%2Fwww.joturl.com%2Fterms-of-service%2F&format=txt

Query parameters

  company = JotUrl
home_link = https://www.joturl.com/
 tos_link = https://www.joturl.com/terms-of-service/
   format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_company=JotUrl
result_home_link=https://www.joturl.com/
result_tos_link=https://www.joturl.com/terms-of-service/
result_id=5dcb2cf8708302538859720db35ef523
result_notes=
result_is_default=0
result_show_refuse_button=0
result_custom_translations=

Example 4 (plain)

Request

https://joturl.com/a/i1/gdprs/add?company=JotUrl&home_link=https%3A%2F%2Fwww.joturl.com%2F&tos_link=https%3A%2F%2Fwww.joturl.com%2Fterms-of-service%2F&format=plain

Query parameters

  company = JotUrl
home_link = https://www.joturl.com/
 tos_link = https://www.joturl.com/terms-of-service/
   format = plain

Response

JotUrl
https://www.joturl.com/
https://www.joturl.com/terms-of-service/
5dcb2cf8708302538859720db35ef523

0
0

Required parameters
parameterdescriptionmax length
companySTRINGcompany name, it is also the name that identifies the template255
home_linkURLcomplete URL to the home page of the company website4000
tos_linkURLcomplete URL to the terms of service page of the company website4000
Optional parameters
parameterdescriptionmax length
custom_translationsJSONstringified JSON of the custom GDPR translations
notesSTRINGtemplate notes (not shown on the GDPR page)255
show_refuse_buttonBOOLEAN1 to show a "refuse all cookies" button on the consent window, 0 otherwise (only available on custom domains)
Return values
parameterdescription
companyecho back of the company input parameter
custom_translationsecho back of the notes input parameter
home_linkecho back of the home_link input parameter
idID of the GDPR template
is_default1 if it is the default template, 0 otherwise
notesecho back of the notes input parameter
show_refuse_button1 to show a "refuse all cookies" button, 0 otherwise
tos_linkecho back of the tos_link input parameter

/gdprs/count

access: [READ]

This method returns the number of GDPR templates.

Example 1 (json)

Request

https://joturl.com/a/i1/gdprs/count?search=test

Query parameters

search = test

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 10
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/gdprs/count?search=test&format=xml

Query parameters

search = test
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>10</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/gdprs/count?search=test&format=txt

Query parameters

search = test
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=10

Example 4 (plain)

Request

https://joturl.com/a/i1/gdprs/count?search=test&format=plain

Query parameters

search = test
format = plain

Response

10
Optional parameters
parameterdescription
searchSTRINGfilters GDPR templates to be extracted by searching them
Return values
parameterdescription
countthe number of GDPR templates

/gdprs/delete

access: [WRITE]

This method deletes one or more GDPR template(s).

Example 1 (json)

Request

https://joturl.com/a/i1/gdprs/delete?ids=dc6c2a34013da0e7cd3182d9a8c171f5,100cf48c1fcafef01f2a22586c504608,e978b78ee0e2450100a005391b36d5bb,b643c057cf9936ff052ef816c6d60ff2,9f94f0c5faab847792044e0aec7fe988

Query parameters

ids = dc6c2a34013da0e7cd3182d9a8c171f5,100cf48c1fcafef01f2a22586c504608,e978b78ee0e2450100a005391b36d5bb,b643c057cf9936ff052ef816c6d60ff2,9f94f0c5faab847792044e0aec7fe988

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 5,
    "id": "a3e704dffd057cb00bef6ae3b2327f54"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/gdprs/delete?ids=dc6c2a34013da0e7cd3182d9a8c171f5,100cf48c1fcafef01f2a22586c504608,e978b78ee0e2450100a005391b36d5bb,b643c057cf9936ff052ef816c6d60ff2,9f94f0c5faab847792044e0aec7fe988&format=xml

Query parameters

   ids = dc6c2a34013da0e7cd3182d9a8c171f5,100cf48c1fcafef01f2a22586c504608,e978b78ee0e2450100a005391b36d5bb,b643c057cf9936ff052ef816c6d60ff2,9f94f0c5faab847792044e0aec7fe988
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>5</deleted>  
    <id>a3e704dffd057cb00bef6ae3b2327f54</id>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/gdprs/delete?ids=dc6c2a34013da0e7cd3182d9a8c171f5,100cf48c1fcafef01f2a22586c504608,e978b78ee0e2450100a005391b36d5bb,b643c057cf9936ff052ef816c6d60ff2,9f94f0c5faab847792044e0aec7fe988&format=txt

Query parameters

   ids = dc6c2a34013da0e7cd3182d9a8c171f5,100cf48c1fcafef01f2a22586c504608,e978b78ee0e2450100a005391b36d5bb,b643c057cf9936ff052ef816c6d60ff2,9f94f0c5faab847792044e0aec7fe988
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=5
result_id=a3e704dffd057cb00bef6ae3b2327f54

Example 4 (plain)

Request

https://joturl.com/a/i1/gdprs/delete?ids=dc6c2a34013da0e7cd3182d9a8c171f5,100cf48c1fcafef01f2a22586c504608,e978b78ee0e2450100a005391b36d5bb,b643c057cf9936ff052ef816c6d60ff2,9f94f0c5faab847792044e0aec7fe988&format=plain

Query parameters

   ids = dc6c2a34013da0e7cd3182d9a8c171f5,100cf48c1fcafef01f2a22586c504608,e978b78ee0e2450100a005391b36d5bb,b643c057cf9936ff052ef816c6d60ff2,9f94f0c5faab847792044e0aec7fe988
format = plain

Response

5
a3e704dffd057cb00bef6ae3b2327f54
Required parameters
parameterdescription
idsARRAY_OF_IDScomma-separated list of GDPR templates to remove, max number of IDs in the list: 100
Return values
parameterdescription
deletednumber of deleted GDPR templates on success, 0 otherwise
idID of the default GDPR template, if available

/gdprs/edit

access: [WRITE]

This method edits a GDPR template.

Example 1 (json)

Request

https://joturl.com/a/i1/gdprs/edit?id=e766c779eb2e27c061c5c4c812deadd2&company=JotUrl&home_link=https%3A%2F%2Fwww.joturl.com%2F&tos_link=https%3A%2F%2Fwww.joturl.com%2Fterms-of-service%2F

Query parameters

       id = e766c779eb2e27c061c5c4c812deadd2
  company = JotUrl
home_link = https://www.joturl.com/
 tos_link = https://www.joturl.com/terms-of-service/

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "e766c779eb2e27c061c5c4c812deadd2",
    "company": "JotUrl",
    "home_link": "https:\/\/www.joturl.com\/",
    "tos_link": "https:\/\/www.joturl.com\/terms-of-service\/",
    "updated": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/gdprs/edit?id=e766c779eb2e27c061c5c4c812deadd2&company=JotUrl&home_link=https%3A%2F%2Fwww.joturl.com%2F&tos_link=https%3A%2F%2Fwww.joturl.com%2Fterms-of-service%2F&format=xml

Query parameters

       id = e766c779eb2e27c061c5c4c812deadd2
  company = JotUrl
home_link = https://www.joturl.com/
 tos_link = https://www.joturl.com/terms-of-service/
   format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>e766c779eb2e27c061c5c4c812deadd2</id>  
    <company>JotUrl</company>  
    <home_link>https://www.joturl.com/</home_link>  
    <tos_link>https://www.joturl.com/terms-of-service/</tos_link>  
    <updated>1</updated>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/gdprs/edit?id=e766c779eb2e27c061c5c4c812deadd2&company=JotUrl&home_link=https%3A%2F%2Fwww.joturl.com%2F&tos_link=https%3A%2F%2Fwww.joturl.com%2Fterms-of-service%2F&format=txt

Query parameters

       id = e766c779eb2e27c061c5c4c812deadd2
  company = JotUrl
home_link = https://www.joturl.com/
 tos_link = https://www.joturl.com/terms-of-service/
   format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=e766c779eb2e27c061c5c4c812deadd2
result_company=JotUrl
result_home_link=https://www.joturl.com/
result_tos_link=https://www.joturl.com/terms-of-service/
result_updated=1

Example 4 (plain)

Request

https://joturl.com/a/i1/gdprs/edit?id=e766c779eb2e27c061c5c4c812deadd2&company=JotUrl&home_link=https%3A%2F%2Fwww.joturl.com%2F&tos_link=https%3A%2F%2Fwww.joturl.com%2Fterms-of-service%2F&format=plain

Query parameters

       id = e766c779eb2e27c061c5c4c812deadd2
  company = JotUrl
home_link = https://www.joturl.com/
 tos_link = https://www.joturl.com/terms-of-service/
   format = plain

Response

e766c779eb2e27c061c5c4c812deadd2
JotUrl
https://www.joturl.com/
https://www.joturl.com/terms-of-service/
1
Required parameters
parameterdescription
idIDID of the GDPR template to edit
Optional parameters
parameterdescriptionmax length
companySTRINGcompany name, it is also the name that identifies the template255
custom_translationsJSONstringified JSON of the custom GDPR translations, see i1/gdprs/add for details
home_linkURLcomplete URL to the home page of the company website4000
is_defaultBOOLEAN1 to set the GDPR template as the default, 0 to remove the default flag (the first available GDPR template will be set as default, including the template identified by id)
notesSTRINGtemplate notes (not shown on the GDPR page)255
show_refuse_buttonBOOLEAN1 to show a "refuse all cookies" button on the consent window, 0 otherwise (only available on custom domains)
tos_linkURLcomplete URL to the terms of service page of the company website4000
Return values
parameterdescription
updated1 on success, 0 otherwise

/gdprs/info

access: [READ]

This method returns info about a GDPR template.

Example 1 (json)

Request

https://joturl.com/a/i1/gdprs/info?fields=id,company,home_link,tos_link,notes,is_default,show_refuse_button,custom_translations&id=aed7aff53247c6ad2007ef29c2b71a5a

Query parameters

fields = id,company,home_link,tos_link,notes,is_default,show_refuse_button,custom_translations
    id = aed7aff53247c6ad2007ef29c2b71a5a

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": [
      {
        "id": "aed7aff53247c6ad2007ef29c2b71a5a",
        "company": "JotUrl",
        "home_link": "https:\/\/www.joturl.com\/",
        "tos_link": "https:\/\/www.joturl.com\/terms-of-service\/",
        "notes": "",
        "is_default": 1,
        "show_refuse_button": 0,
        "custom_translations": null
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/gdprs/info?fields=id,company,home_link,tos_link,notes,is_default,show_refuse_button,custom_translations&id=aed7aff53247c6ad2007ef29c2b71a5a&format=xml

Query parameters

fields = id,company,home_link,tos_link,notes,is_default,show_refuse_button,custom_translations
    id = aed7aff53247c6ad2007ef29c2b71a5a
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <i0>
        <id>aed7aff53247c6ad2007ef29c2b71a5a</id>  
        <company>JotUrl</company>  
        <home_link>https://www.joturl.com/</home_link>  
        <tos_link>https://www.joturl.com/terms-of-service/</tos_link>  
        <notes></notes>  
        <is_default>1</is_default>  
        <show_refuse_button>0</show_refuse_button>  
        <custom_translations></custom_translations>  
      </i0>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/gdprs/info?fields=id,company,home_link,tos_link,notes,is_default,show_refuse_button,custom_translations&id=aed7aff53247c6ad2007ef29c2b71a5a&format=txt

Query parameters

fields = id,company,home_link,tos_link,notes,is_default,show_refuse_button,custom_translations
    id = aed7aff53247c6ad2007ef29c2b71a5a
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_0_id=aed7aff53247c6ad2007ef29c2b71a5a
result_data_0_company=JotUrl
result_data_0_home_link=https://www.joturl.com/
result_data_0_tos_link=https://www.joturl.com/terms-of-service/
result_data_0_notes=
result_data_0_is_default=1
result_data_0_show_refuse_button=0
result_data_0_custom_translations=

Example 4 (plain)

Request

https://joturl.com/a/i1/gdprs/info?fields=id,company,home_link,tos_link,notes,is_default,show_refuse_button,custom_translations&id=aed7aff53247c6ad2007ef29c2b71a5a&format=plain

Query parameters

fields = id,company,home_link,tos_link,notes,is_default,show_refuse_button,custom_translations
    id = aed7aff53247c6ad2007ef29c2b71a5a
format = plain

Response

aed7aff53247c6ad2007ef29c2b71a5a
JotUrl
https://www.joturl.com/
https://www.joturl.com/terms-of-service/

1
0

Required parameters
parameterdescription
fieldsARRAYcomma-separated list of fields to return, available fields: count, id, company, home_link, tos_link, notes, is_default, show_refuse_button, custom_translations
idIDID of the GDPR template
Return values
parameterdescription
dataarray containing information on the GDPR templates, returned information depends on the fields parameter.

/gdprs/list

access: [READ]

This method returns a list of GDPR templates.

Example 1 (json)

Request

https://joturl.com/a/i1/gdprs/list?fields=count,id,company,home_link,tos_link,notes,is_default,show_refuse_button,custom_translations

Query parameters

fields = count,id,company,home_link,tos_link,notes,is_default,show_refuse_button,custom_translations

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 1,
    "data": [
      {
        "id": "16c2d0bdc3c2c13e8cd1dbf440a6882c",
        "company": "JotUrl",
        "home_link": "https:\/\/www.joturl.com\/",
        "tos_link": "https:\/\/www.joturl.com\/terms-of-service\/",
        "notes": "",
        "is_default": 1,
        "show_refuse_button": 0,
        "custom_translations": null
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/gdprs/list?fields=count,id,company,home_link,tos_link,notes,is_default,show_refuse_button,custom_translations&format=xml

Query parameters

fields = count,id,company,home_link,tos_link,notes,is_default,show_refuse_button,custom_translations
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>1</count>  
    <data>
      <i0>
        <id>16c2d0bdc3c2c13e8cd1dbf440a6882c</id>  
        <company>JotUrl</company>  
        <home_link>https://www.joturl.com/</home_link>  
        <tos_link>https://www.joturl.com/terms-of-service/</tos_link>  
        <notes></notes>  
        <is_default>1</is_default>  
        <show_refuse_button>0</show_refuse_button>  
        <custom_translations></custom_translations>  
      </i0>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/gdprs/list?fields=count,id,company,home_link,tos_link,notes,is_default,show_refuse_button,custom_translations&format=txt

Query parameters

fields = count,id,company,home_link,tos_link,notes,is_default,show_refuse_button,custom_translations
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=1
result_data_0_id=16c2d0bdc3c2c13e8cd1dbf440a6882c
result_data_0_company=JotUrl
result_data_0_home_link=https://www.joturl.com/
result_data_0_tos_link=https://www.joturl.com/terms-of-service/
result_data_0_notes=
result_data_0_is_default=1
result_data_0_show_refuse_button=0
result_data_0_custom_translations=

Example 4 (plain)

Request

https://joturl.com/a/i1/gdprs/list?fields=count,id,company,home_link,tos_link,notes,is_default,show_refuse_button,custom_translations&format=plain

Query parameters

fields = count,id,company,home_link,tos_link,notes,is_default,show_refuse_button,custom_translations
format = plain

Response

1
16c2d0bdc3c2c13e8cd1dbf440a6882c
JotUrl
https://www.joturl.com/
https://www.joturl.com/terms-of-service/

1
0

Required parameters
parameterdescription
fieldsARRAYcomma-separated list of fields to return, available fields: count, id, company, home_link, tos_link, notes, is_default, show_refuse_button, custom_translations
Optional parameters
parameterdescription
lengthINTEGERextracts this number of GDPR templates (maxmimum allowed: 100)
orderbyARRAYorders GDPR templates by field, available fields: id, company, home_link, tos_link, notes, is_default, show_refuse_button, custom_translations
searchSTRINGfilters GDPR templates to be extracted by searching them
sortSTRINGsorts GDPR templates in ascending (ASC) or descending (DESC) order
startINTEGERstarts to extract GDPR templates from this position
Return values
parameterdescription
count[OPTIONAL] total number of GDPR templates, returned only if count is passed in fields
dataarray containing information on the GDPR templates, returned information depends on the fields parameter.

/gdprs/preview

access: [READ]

This method returns a preview for the GDPR consent page (HTML).

Example 1 (json)

Request

https://joturl.com/a/i1/gdprs/preview?id=88bbf7859a06751acab1a048e48d40b2

Query parameters

id = 88bbf7859a06751acab1a048e48d40b2

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "html": "<html lang=\"en\"> [GDPR consent HTML] <\/html>"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/gdprs/preview?id=88bbf7859a06751acab1a048e48d40b2&format=xml

Query parameters

    id = 88bbf7859a06751acab1a048e48d40b2
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <html><[CDATA[&lt;html lang="en"&gt; [GDPR consent HTML] &lt;/html&gt;]]></html>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/gdprs/preview?id=88bbf7859a06751acab1a048e48d40b2&format=txt

Query parameters

    id = 88bbf7859a06751acab1a048e48d40b2
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_html=&lt;html lang="en"&gt; [GDPR consent HTML] &lt;/html&gt;

Example 4 (plain)

Request

https://joturl.com/a/i1/gdprs/preview?id=88bbf7859a06751acab1a048e48d40b2&format=plain

Query parameters

    id = 88bbf7859a06751acab1a048e48d40b2
format = plain

Response

&lt;html lang="en"&gt; [GDPR consent HTML] &lt;/html&gt;
Optional parameters
parameterdescriptionmax length
companySTRINGNA255
custom_translationsJSONcustom translations for the GDPR consent preview
home_linkURLNA4000
idIDID of the GDPR template
show_refuse_buttonBOOLEANNA
tos_linkURLNA4000
Return values
parameterdescription
htmlGDPR consent HTML

/gdprs/property

access: [READ]

This method returns a list of property for a custom GDPR consent.

Example 1 (json)

Request

https://joturl.com/a/i1/gdprs/property

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "about_cookies": {
      "type": "text",
      "default": "About cookies",
      "notes": "label of the \"about cookies\" tab",
      "max-length": 50
    },
    "accept_button": {
      "type": "text",
      "default": "Accept cookies",
      "notes": "label of the accept button",
      "max-length": 50
    },
    "agreement": {
      "type": "markdown",
      "default": "By clicking \"Accept cookies,\" you agree to the sto [...]",
      "notes": "agreement text",
      "max-length": 1000
    },
    "caption": {
      "type": "text",
      "default": "Cookies",
      "notes": "title of the consent window",
      "max-length": 50
    },
    "consent": {
      "type": "markdown",
      "default": "%COMPANY_WITH_LINK% uses cookies to customise cont [...]",
      "notes": "consent text",
      "max-length": 1000
    },
    "cookie_control_label": {
      "type": "text",
      "default": "aboutcookies.org",
      "notes": "label of the aboutcookies.org link",
      "max-length": 100
    },
    "cookie_control_link": {
      "type": "url",
      "default": "https:\/\/www.aboutcookies.org\/",
      "notes": "URL of the aboutcookies.org page",
      "max-length": 2000
    },
    "cookies_enabled": {
      "type": "text",
      "default": "Enabled",
      "notes": "\"enabled\" header of the consent table",
      "max-length": 30
    },
    "cookies_settings": {
      "type": "text",
      "default": "Cookies settings",
      "notes": "title of the detailed cookie settings page",
      "max-length": 50
    },
    "cookies_used": {
      "type": "text",
      "default": "Cookie name",
      "notes": "\"cookie name\" header of the consent table",
      "max-length": 30
    },
    "description_control_cookies": {
      "type": "markdown",
      "default": "You can control and\/or delete cookies as you wish  [...]",
      "notes": "content of the \"How to control cookies\" section",
      "max-length": 1000
    },
    "description_cookies": {
      "type": "markdown",
      "default": "A cookie is a small text file that a website saves [...]",
      "notes": "content of the \"What are cookies?\" section",
      "max-length": 1000
    },
    "description_marketing_cookies": {
      "type": "markdown",
      "default": "Marketing cookies are used to track visitors acros [...]",
      "notes": "content of the \"What are marketing cookies?\" section",
      "max-length": 1000
    },
    "descriptions.adroll": {
      "type": "markdown",
      "default": "AdRoll is a retargeting and prospecting platform f [...]",
      "notes": "AdRoll consent details",
      "max-length": 1000
    },
    "descriptions.bing": {
      "type": "markdown",
      "default": "Bing Remarketing is a remarketing and behavioral t [...]",
      "notes": "Bing consent details",
      "max-length": 1000
    },
    "descriptions.custom": {
      "type": "markdown",
      "default": "Please refer to the terms of service and cookie po [...]",
      "notes": "Custom consent details",
      "max-length": 1000
    },
    "descriptions.facebook": {
      "type": "markdown",
      "default": "Facebook Remarketing is a remarketing and behavior [...]",
      "notes": "Facebook consent details",
      "max-length": 1000
    },
    "descriptions.google_adwords": {
      "type": "markdown",
      "default": "Google AdWords Remarketing is a remarketing and be [...]",
      "notes": "Google AdWords consent details",
      "max-length": 1000
    },
    "descriptions.google_analytics": {
      "type": "markdown",
      "default": "Google Analytics for Display Advertising is a rema [...]",
      "notes": "Google Analytics consent details",
      "max-length": 1000
    },
    "descriptions.google_tag_manager": {
      "type": "markdown",
      "default": "Google Tag Manager is a tag management service pro [...]",
      "notes": "Google Tag Manager consent details",
      "max-length": 1000
    },
    "descriptions.linkedin": {
      "type": "markdown",
      "default": "LinkedIn Website Retargeting is a remarketing and  [...]",
      "notes": "LinkedIn consent details",
      "max-length": 1000
    },
    "descriptions.manychat": {
      "type": "markdown",
      "default": "ManyChat is a leading Facebook Messenger marketing [...]",
      "notes": "ManyChat consent details",
      "max-length": 1000
    },
    "descriptions.pinterest": {
      "type": "markdown",
      "default": "Pinterest Remarketing is a remarketing and behavio [...]",
      "notes": "Pinterest consent details",
      "max-length": 1000
    },
    "descriptions.quora": {
      "type": "markdown",
      "default": "Quora is an American social question-and-answer we [...]",
      "notes": "Quora consent details",
      "max-length": 1000
    },
    "descriptions.snapchat": {
      "type": "markdown",
      "default": "Snapchat is a mobile app for Android and iOS devic [...]",
      "notes": "Snapchat consent details",
      "max-length": 1000
    },
    "descriptions.tiktok": {
      "type": "markdown",
      "default": "TikTok (Douyin) Remarketing is a remarketing and b [...]",
      "notes": "TikTok consent details",
      "max-length": 1000
    },
    "descriptions.twitter": {
      "type": "markdown",
      "default": "Twitter Remarketing is a remarketing and behaviora [...]",
      "notes": "Twitter consent details",
      "max-length": 1000
    },
    "here": {
      "type": "text",
      "default": "here",
      "notes": "text of the link that leads to the \"control and\/or delete cookies\" page",
      "max-length": 50
    },
    "marketing_cookies": {
      "type": "text",
      "default": "Marketing cookies",
      "notes": "label of the \"marketing cookies\" tab",
      "max-length": 50
    },
    "noscript": {
      "type": "text",
      "default": "You need to enable JavaScript to run this page.",
      "notes": "shown when the user's browser does not support JavaScript",
      "max-length": 100
    },
    "refuse_button": {
      "type": "text",
      "default": "I refuse cookies",
      "notes": "label of the refuse button",
      "max-length": 50
    },
    "save_button": {
      "type": "text",
      "default": "Save & continue",
      "notes": "label of the save button",
      "max-length": 50
    },
    "see_details": {
      "type": "text",
      "default": "See details",
      "notes": "text of the link that leads to the extended consent page (custom page)",
      "max-length": 50
    },
    "settings_button": {
      "type": "text",
      "default": "Cookies settings",
      "notes": "label of the settings button",
      "max-length": 50
    },
    "title": {
      "type": "text",
      "default": "%COMPANY% GDPR - Cookie consent form",
      "notes": "title of the HTML page consent",
      "max-length": 50
    },
    "title_control_cookies": {
      "type": "text",
      "default": "How to control cookies",
      "notes": "title of the \"How to control cookies\" section",
      "max-length": 50
    },
    "title_cookies": {
      "type": "text",
      "default": "What are cookies?",
      "notes": "title of the \"What are cookies?\" section",
      "max-length": 50
    },
    "title_marketing_cookies": {
      "type": "text",
      "default": "What are marketing cookies?",
      "notes": "title of the \"What are marketing cookies?\" section",
      "max-length": 50
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/gdprs/property?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <about_cookies>
      <type>text</type>  
      <default>About cookies</default>  
      <notes>label of the "about cookies" tab</notes>  
      <max-length>50</max-length>  
    </about_cookies>  
    <accept_button>
      <type>text</type>  
      <default>Accept cookies</default>  
      <notes>label of the accept button</notes>  
      <max-length>50</max-length>  
    </accept_button>  
    <agreement>
      <type>markdown</type>  
      <default>By clicking "Accept cookies," you agree to the sto [...]</default>  
      <notes>agreement text</notes>  
      <max-length>1000</max-length>  
    </agreement>  
    <caption>
      <type>text</type>  
      <default>Cookies</default>  
      <notes>title of the consent window</notes>  
      <max-length>50</max-length>  
    </caption>  
    <consent>
      <type>markdown</type>  
      <default>%COMPANY_WITH_LINK% uses cookies to customise cont [...]</default>  
      <notes>consent text</notes>  
      <max-length>1000</max-length>  
    </consent>  
    <cookie_control_label>
      <type>text</type>  
      <default>aboutcookies.org</default>  
      <notes>label of the aboutcookies.org link</notes>  
      <max-length>100</max-length>  
    </cookie_control_label>  
    <cookie_control_link>
      <type>url</type>  
      <default>https://www.aboutcookies.org/</default>  
      <notes>URL of the aboutcookies.org page</notes>  
      <max-length>2000</max-length>  
    </cookie_control_link>  
    <cookies_enabled>
      <type>text</type>  
      <default>Enabled</default>  
      <notes>"enabled" header of the consent table</notes>  
      <max-length>30</max-length>  
    </cookies_enabled>  
    <cookies_settings>
      <type>text</type>  
      <default>Cookies settings</default>  
      <notes>title of the detailed cookie settings page</notes>  
      <max-length>50</max-length>  
    </cookies_settings>  
    <cookies_used>
      <type>text</type>  
      <default>Cookie name</default>  
      <notes>"cookie name" header of the consent table</notes>  
      <max-length>30</max-length>  
    </cookies_used>  
    <description_control_cookies>
      <type>markdown</type>  
      <default>You can control and/or delete cookies as you wish  [...]</default>  
      <notes>content of the "How to control cookies" section</notes>  
      <max-length>1000</max-length>  
    </description_control_cookies>  
    <description_cookies>
      <type>markdown</type>  
      <default>A cookie is a small text file that a website saves [...]</default>  
      <notes>content of the "What are cookies?" section</notes>  
      <max-length>1000</max-length>  
    </description_cookies>  
    <description_marketing_cookies>
      <type>markdown</type>  
      <default>Marketing cookies are used to track visitors acros [...]</default>  
      <notes>content of the "What are marketing cookies?" section</notes>  
      <max-length>1000</max-length>  
    </description_marketing_cookies>  
    <descriptions.adroll>
      <type>markdown</type>  
      <default>AdRoll is a retargeting and prospecting platform f [...]</default>  
      <notes>AdRoll consent details</notes>  
      <max-length>1000</max-length>  
    </descriptions.adroll>  
    <descriptions.bing>
      <type>markdown</type>  
      <default>Bing Remarketing is a remarketing and behavioral t [...]</default>  
      <notes>Bing consent details</notes>  
      <max-length>1000</max-length>  
    </descriptions.bing>  
    <descriptions.custom>
      <type>markdown</type>  
      <default>Please refer to the terms of service and cookie po [...]</default>  
      <notes>Custom consent details</notes>  
      <max-length>1000</max-length>  
    </descriptions.custom>  
    <descriptions.facebook>
      <type>markdown</type>  
      <default>Facebook Remarketing is a remarketing and behavior [...]</default>  
      <notes>Facebook consent details</notes>  
      <max-length>1000</max-length>  
    </descriptions.facebook>  
    <descriptions.google_adwords>
      <type>markdown</type>  
      <default>Google AdWords Remarketing is a remarketing and be [...]</default>  
      <notes>Google AdWords consent details</notes>  
      <max-length>1000</max-length>  
    </descriptions.google_adwords>  
    <descriptions.google_analytics>
      <type>markdown</type>  
      <default>Google Analytics for Display Advertising is a rema [...]</default>  
      <notes>Google Analytics consent details</notes>  
      <max-length>1000</max-length>  
    </descriptions.google_analytics>  
    <descriptions.google_tag_manager>
      <type>markdown</type>  
      <default>Google Tag Manager is a tag management service pro [...]</default>  
      <notes>Google Tag Manager consent details</notes>  
      <max-length>1000</max-length>  
    </descriptions.google_tag_manager>  
    <descriptions.linkedin>
      <type>markdown</type>  
      <default>LinkedIn Website Retargeting is a remarketing and  [...]</default>  
      <notes>LinkedIn consent details</notes>  
      <max-length>1000</max-length>  
    </descriptions.linkedin>  
    <descriptions.manychat>
      <type>markdown</type>  
      <default>ManyChat is a leading Facebook Messenger marketing [...]</default>  
      <notes>ManyChat consent details</notes>  
      <max-length>1000</max-length>  
    </descriptions.manychat>  
    <descriptions.pinterest>
      <type>markdown</type>  
      <default>Pinterest Remarketing is a remarketing and behavio [...]</default>  
      <notes>Pinterest consent details</notes>  
      <max-length>1000</max-length>  
    </descriptions.pinterest>  
    <descriptions.quora>
      <type>markdown</type>  
      <default>Quora is an American social question-and-answer we [...]</default>  
      <notes>Quora consent details</notes>  
      <max-length>1000</max-length>  
    </descriptions.quora>  
    <descriptions.snapchat>
      <type>markdown</type>  
      <default>Snapchat is a mobile app for Android and iOS devic [...]</default>  
      <notes>Snapchat consent details</notes>  
      <max-length>1000</max-length>  
    </descriptions.snapchat>  
    <descriptions.tiktok>
      <type>markdown</type>  
      <default>TikTok (Douyin) Remarketing is a remarketing and b [...]</default>  
      <notes>TikTok consent details</notes>  
      <max-length>1000</max-length>  
    </descriptions.tiktok>  
    <descriptions.twitter>
      <type>markdown</type>  
      <default>Twitter Remarketing is a remarketing and behaviora [...]</default>  
      <notes>Twitter consent details</notes>  
      <max-length>1000</max-length>  
    </descriptions.twitter>  
    <here>
      <type>text</type>  
      <default>here</default>  
      <notes>text of the link that leads to the "control and/or delete cookies" page</notes>  
      <max-length>50</max-length>  
    </here>  
    <marketing_cookies>
      <type>text</type>  
      <default>Marketing cookies</default>  
      <notes>label of the "marketing cookies" tab</notes>  
      <max-length>50</max-length>  
    </marketing_cookies>  
    <noscript>
      <type>text</type>  
      <default>You need to enable JavaScript to run this page.</default>  
      <notes>shown when the user's browser does not support JavaScript</notes>  
      <max-length>100</max-length>  
    </noscript>  
    <refuse_button>
      <type>text</type>  
      <default>I refuse cookies</default>  
      <notes>label of the refuse button</notes>  
      <max-length>50</max-length>  
    </refuse_button>  
    <save_button>
      <type>text</type>  
      <default><[CDATA[Save &amp; continue]]></default>  
      <notes>label of the save button</notes>  
      <max-length>50</max-length>  
    </save_button>  
    <see_details>
      <type>text</type>  
      <default>See details</default>  
      <notes>text of the link that leads to the extended consent page (custom page)</notes>  
      <max-length>50</max-length>  
    </see_details>  
    <settings_button>
      <type>text</type>  
      <default>Cookies settings</default>  
      <notes>label of the settings button</notes>  
      <max-length>50</max-length>  
    </settings_button>  
    <title>
      <type>text</type>  
      <default>%COMPANY% GDPR - Cookie consent form</default>  
      <notes>title of the HTML page consent</notes>  
      <max-length>50</max-length>  
    </title>  
    <title_control_cookies>
      <type>text</type>  
      <default>How to control cookies</default>  
      <notes>title of the "How to control cookies" section</notes>  
      <max-length>50</max-length>  
    </title_control_cookies>  
    <title_cookies>
      <type>text</type>  
      <default>What are cookies?</default>  
      <notes>title of the "What are cookies?" section</notes>  
      <max-length>50</max-length>  
    </title_cookies>  
    <title_marketing_cookies>
      <type>text</type>  
      <default>What are marketing cookies?</default>  
      <notes>title of the "What are marketing cookies?" section</notes>  
      <max-length>50</max-length>  
    </title_marketing_cookies>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/gdprs/property?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_about_cookies_type=text
result_about_cookies_default=About cookies
result_about_cookies_notes=label of the "about cookies" tab
result_about_cookies_max-length=50
result_accept_button_type=text
result_accept_button_default=Accept cookies
result_accept_button_notes=label of the accept button
result_accept_button_max-length=50
result_agreement_type=markdown
result_agreement_default=By clicking "Accept cookies," you agree to the sto [...]
result_agreement_notes=agreement text
result_agreement_max-length=1000
result_caption_type=text
result_caption_default=Cookies
result_caption_notes=title of the consent window
result_caption_max-length=50
result_consent_type=markdown
result_consent_default=%COMPANY_WITH_LINK% uses cookies to customise cont [...]
result_consent_notes=consent text
result_consent_max-length=1000
result_cookie_control_label_type=text
result_cookie_control_label_default=aboutcookies.org
result_cookie_control_label_notes=label of the aboutcookies.org link
result_cookie_control_label_max-length=100
result_cookie_control_link_type=url
result_cookie_control_link_default=https://www.aboutcookies.org/
result_cookie_control_link_notes=URL of the aboutcookies.org page
result_cookie_control_link_max-length=2000
result_cookies_enabled_type=text
result_cookies_enabled_default=Enabled
result_cookies_enabled_notes="enabled" header of the consent table
result_cookies_enabled_max-length=30
result_cookies_settings_type=text
result_cookies_settings_default=Cookies settings
result_cookies_settings_notes=title of the detailed cookie settings page
result_cookies_settings_max-length=50
result_cookies_used_type=text
result_cookies_used_default=Cookie name
result_cookies_used_notes="cookie name" header of the consent table
result_cookies_used_max-length=30
result_description_control_cookies_type=markdown
result_description_control_cookies_default=You can control and/or delete cookies as you wish  [...]
result_description_control_cookies_notes=content of the "How to control cookies" section
result_description_control_cookies_max-length=1000
result_description_cookies_type=markdown
result_description_cookies_default=A cookie is a small text file that a website saves [...]
result_description_cookies_notes=content of the "What are cookies?" section
result_description_cookies_max-length=1000
result_description_marketing_cookies_type=markdown
result_description_marketing_cookies_default=Marketing cookies are used to track visitors acros [...]
result_description_marketing_cookies_notes=content of the "What are marketing cookies?" section
result_description_marketing_cookies_max-length=1000
result_descriptions.adroll_type=markdown
result_descriptions.adroll_default=AdRoll is a retargeting and prospecting platform f [...]
result_descriptions.adroll_notes=AdRoll consent details
result_descriptions.adroll_max-length=1000
result_descriptions.bing_type=markdown
result_descriptions.bing_default=Bing Remarketing is a remarketing and behavioral t [...]
result_descriptions.bing_notes=Bing consent details
result_descriptions.bing_max-length=1000
result_descriptions.custom_type=markdown
result_descriptions.custom_default=Please refer to the terms of service and cookie po [...]
result_descriptions.custom_notes=Custom consent details
result_descriptions.custom_max-length=1000
result_descriptions.facebook_type=markdown
result_descriptions.facebook_default=Facebook Remarketing is a remarketing and behavior [...]
result_descriptions.facebook_notes=Facebook consent details
result_descriptions.facebook_max-length=1000
result_descriptions.google_adwords_type=markdown
result_descriptions.google_adwords_default=Google AdWords Remarketing is a remarketing and be [...]
result_descriptions.google_adwords_notes=Google AdWords consent details
result_descriptions.google_adwords_max-length=1000
result_descriptions.google_analytics_type=markdown
result_descriptions.google_analytics_default=Google Analytics for Display Advertising is a rema [...]
result_descriptions.google_analytics_notes=Google Analytics consent details
result_descriptions.google_analytics_max-length=1000
result_descriptions.google_tag_manager_type=markdown
result_descriptions.google_tag_manager_default=Google Tag Manager is a tag management service pro [...]
result_descriptions.google_tag_manager_notes=Google Tag Manager consent details
result_descriptions.google_tag_manager_max-length=1000
result_descriptions.linkedin_type=markdown
result_descriptions.linkedin_default=LinkedIn Website Retargeting is a remarketing and  [...]
result_descriptions.linkedin_notes=LinkedIn consent details
result_descriptions.linkedin_max-length=1000
result_descriptions.manychat_type=markdown
result_descriptions.manychat_default=ManyChat is a leading Facebook Messenger marketing [...]
result_descriptions.manychat_notes=ManyChat consent details
result_descriptions.manychat_max-length=1000
result_descriptions.pinterest_type=markdown
result_descriptions.pinterest_default=Pinterest Remarketing is a remarketing and behavio [...]
result_descriptions.pinterest_notes=Pinterest consent details
result_descriptions.pinterest_max-length=1000
result_descriptions.quora_type=markdown
result_descriptions.quora_default=Quora is an American social question-and-answer we [...]
result_descriptions.quora_notes=Quora consent details
result_descriptions.quora_max-length=1000
result_descriptions.snapchat_type=markdown
result_descriptions.snapchat_default=Snapchat is a mobile app for Android and iOS devic [...]
result_descriptions.snapchat_notes=Snapchat consent details
result_descriptions.snapchat_max-length=1000
result_descriptions.tiktok_type=markdown
result_descriptions.tiktok_default=TikTok (Douyin) Remarketing is a remarketing and b [...]
result_descriptions.tiktok_notes=TikTok consent details
result_descriptions.tiktok_max-length=1000
result_descriptions.twitter_type=markdown
result_descriptions.twitter_default=Twitter Remarketing is a remarketing and behaviora [...]
result_descriptions.twitter_notes=Twitter consent details
result_descriptions.twitter_max-length=1000
result_here_type=text
result_here_default=here
result_here_notes=text of the link that leads to the "control and/or delete cookies" page
result_here_max-length=50
result_marketing_cookies_type=text
result_marketing_cookies_default=Marketing cookies
result_marketing_cookies_notes=label of the "marketing cookies" tab
result_marketing_cookies_max-length=50
result_noscript_type=text
result_noscript_default=You need to enable JavaScript to run this page.
result_noscript_notes=shown when the user's browser does not support JavaScript
result_noscript_max-length=100
result_refuse_button_type=text
result_refuse_button_default=I refuse cookies
result_refuse_button_notes=label of the refuse button
result_refuse_button_max-length=50
result_save_button_type=text
result_save_button_default=Save &amp; continue
result_save_button_notes=label of the save button
result_save_button_max-length=50
result_see_details_type=text
result_see_details_default=See details
result_see_details_notes=text of the link that leads to the extended consent page (custom page)
result_see_details_max-length=50
result_settings_button_type=text
result_settings_button_default=Cookies settings
result_settings_button_notes=label of the settings button
result_settings_button_max-length=50
result_title_type=text
result_title_default=%COMPANY% GDPR - Cookie consent form
result_title_notes=title of the HTML page consent
result_title_max-length=50
result_title_control_cookies_type=text
result_title_control_cookies_default=How to control cookies
result_title_control_cookies_notes=title of the "How to control cookies" section
result_title_control_cookies_max-length=50
result_title_cookies_type=text
result_title_cookies_default=What are cookies?
result_title_cookies_notes=title of the "What are cookies?" section
result_title_cookies_max-length=50
result_title_marketing_cookies_type=text
result_title_marketing_cookies_default=What are marketing cookies?
result_title_marketing_cookies_notes=title of the "What are marketing cookies?" section
result_title_marketing_cookies_max-length=50

Example 4 (plain)

Request

https://joturl.com/a/i1/gdprs/property?format=plain

Query parameters

format = plain

Response

text
default:About cookies
label of the "about cookies" tab
50
text
default:Accept cookies
label of the accept button
50
markdown
default:By clicking "Accept cookies," you agree to the sto [...]
agreement text
1000
text
default:Cookies
title of the consent window
50
markdown
default:%COMPANY_WITH_LINK% uses cookies to customise cont [...]
consent text
1000
text
default:aboutcookies.org
label of the aboutcookies.org link
100
url
default:https://www.aboutcookies.org/
URL of the aboutcookies.org page
2000
text
default:Enabled
"enabled" header of the consent table
30
text
default:Cookies settings
title of the detailed cookie settings page
50
text
default:Cookie name
"cookie name" header of the consent table
30
markdown
default:You can control and/or delete cookies as you wish  [...]
content of the "How to control cookies" section
1000
markdown
default:A cookie is a small text file that a website saves [...]
content of the "What are cookies?" section
1000
markdown
default:Marketing cookies are used to track visitors acros [...]
content of the "What are marketing cookies?" section
1000
markdown
default:AdRoll is a retargeting and prospecting platform f [...]
AdRoll consent details
1000
markdown
default:Bing Remarketing is a remarketing and behavioral t [...]
Bing consent details
1000
markdown
default:Please refer to the terms of service and cookie po [...]
Custom consent details
1000
markdown
default:Facebook Remarketing is a remarketing and behavior [...]
Facebook consent details
1000
markdown
default:Google AdWords Remarketing is a remarketing and be [...]
Google AdWords consent details
1000
markdown
default:Google Analytics for Display Advertising is a rema [...]
Google Analytics consent details
1000
markdown
default:Google Tag Manager is a tag management service pro [...]
Google Tag Manager consent details
1000
markdown
default:LinkedIn Website Retargeting is a remarketing and  [...]
LinkedIn consent details
1000
markdown
default:ManyChat is a leading Facebook Messenger marketing [...]
ManyChat consent details
1000
markdown
default:Pinterest Remarketing is a remarketing and behavio [...]
Pinterest consent details
1000
markdown
default:Quora is an American social question-and-answer we [...]
Quora consent details
1000
markdown
default:Snapchat is a mobile app for Android and iOS devic [...]
Snapchat consent details
1000
markdown
default:TikTok (Douyin) Remarketing is a remarketing and b [...]
TikTok consent details
1000
markdown
default:Twitter Remarketing is a remarketing and behaviora [...]
Twitter consent details
1000
text
default:here
text of the link that leads to the "control and/or delete cookies" page
50
text
default:Marketing cookies
label of the "marketing cookies" tab
50
text
default:You need to enable JavaScript to run this page.
shown when the user's browser does not support JavaScript
100
text
default:I refuse cookies
label of the refuse button
50
text
default:Save &amp; continue
label of the save button
50
text
default:See details
text of the link that leads to the extended consent page (custom page)
50
text
default:Cookies settings
label of the settings button
50
text
default:%COMPANY% GDPR - Cookie consent form
title of the HTML page consent
50
text
default:How to control cookies
title of the "How to control cookies" section
50
text
default:What are cookies?
title of the "What are cookies?" section
50
text
default:What are marketing cookies?
title of the "What are marketing cookies?" section
50
Return values
parameterdescription
about_cookieslabel of the "about cookies" tab (type: text, max length: 50)
accept_buttonlabel of the accept button (type: text, max length: 50)
agreementagreement text (type: markdown, max length: 1000)
captiontitle of the consent window (type: text, max length: 50)
consentconsent text (type: markdown, max length: 1000)
cookie_control_labellabel of the aboutcookies.org link (type: text, max length: 100)
cookie_control_linkURL of the aboutcookies.org page (type: url, max length: 2000)
cookies_enabled"enabled" header of the consent table (type: text, max length: 30)
cookies_settingstitle of the detailed cookie settings page (type: text, max length: 50)
cookies_used"cookie name" header of the consent table (type: text, max length: 30)
description_control_cookiescontent of the "How to control cookies" section (type: markdown, max length: 1000)
description_cookiescontent of the "What are cookies?" section (type: markdown, max length: 1000)
description_marketing_cookiescontent of the "What are marketing cookies?" section (type: markdown, max length: 1000)
descriptions.adrollAdRoll consent details (type: markdown, max length: 1000)
descriptions.bingBing consent details (type: markdown, max length: 1000)
descriptions.customCustom consent details (type: markdown, max length: 1000)
descriptions.facebookFacebook consent details (type: markdown, max length: 1000)
descriptions.google_adwordsGoogle AdWords consent details (type: markdown, max length: 1000)
descriptions.google_analyticsGoogle Analytics consent details (type: markdown, max length: 1000)
descriptions.google_tag_managerGoogle Tag Manager consent details (type: markdown, max length: 1000)
descriptions.linkedinLinkedIn consent details (type: markdown, max length: 1000)
descriptions.manychatManyChat consent details (type: markdown, max length: 1000)
descriptions.pinterestPinterest consent details (type: markdown, max length: 1000)
descriptions.quoraQuora consent details (type: markdown, max length: 1000)
descriptions.snapchatSnapchat consent details (type: markdown, max length: 1000)
descriptions.tiktokTikTok consent details (type: markdown, max length: 1000)
descriptions.twitterTwitter consent details (type: markdown, max length: 1000)
heretext of the link that leads to the "control and/or delete cookies" page (type: text, max length: 50)
marketing_cookieslabel of the "marketing cookies" tab (type: text, max length: 50)
noscriptshown when the user's browser does not support JavaScript (type: text, max length: 100)
refuse_buttonlabel of the refuse button (type: text, max length: 50)
save_buttonlabel of the save button (type: text, max length: 50)
see_detailstext of the link that leads to the extended consent page (custom page) (type: text, max length: 50)
settings_buttonlabel of the settings button (type: text, max length: 50)
titletitle of the HTML page consent (type: text, max length: 50)
title_control_cookiestitle of the "How to control cookies" section (type: text, max length: 50)
title_cookiestitle of the "What are cookies?" section (type: text, max length: 50)
title_marketing_cookiestitle of the "What are marketing cookies?" section (type: text, max length: 50)

/jotbars

/jotbars/property

access: [READ]

This method returns a list of property of a jotbar.

Example 1 (json)

Request

https://joturl.com/a/i1/jotbars/property?context=url

Query parameters

context = url

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "positions": "inherit,right,left,top,bottom,empty",
    "dimensions": "inherit,small,medium,big"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/jotbars/property?context=url&format=xml

Query parameters

context = url
 format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <positions>inherit,right,left,top,bottom,empty</positions>  
    <dimensions>inherit,small,medium,big</dimensions>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/jotbars/property?context=url&format=txt

Query parameters

context = url
 format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_positions=inherit,right,left,top,bottom,empty
result_dimensions=inherit,small,medium,big

Example 4 (plain)

Request

https://joturl.com/a/i1/jotbars/property?context=url&format=plain

Query parameters

context = url
 format = plain

Response

inherit,right,left,top,bottom,empty
inherit,small,medium,big

Example 5 (json)

Request

https://joturl.com/a/i1/jotbars/property?context=project

Query parameters

context = project

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "positions": "inherit,right,left,top,bottom,empty",
    "dimensions": "inherit,small,medium,big"
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/jotbars/property?context=project&format=xml

Query parameters

context = project
 format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <positions>inherit,right,left,top,bottom,empty</positions>  
    <dimensions>inherit,small,medium,big</dimensions>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/jotbars/property?context=project&format=txt

Query parameters

context = project
 format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_positions=inherit,right,left,top,bottom,empty
result_dimensions=inherit,small,medium,big

Example 8 (plain)

Request

https://joturl.com/a/i1/jotbars/property?context=project&format=plain

Query parameters

context = project
 format = plain

Response

inherit,right,left,top,bottom,empty
inherit,small,medium,big

Example 9 (json)

Request

https://joturl.com/a/i1/jotbars/property?context=user

Query parameters

context = user

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "positions": "right,left,top,bottom,empty",
    "dimensions": "small,medium,big"
  }
}

Example 10 (xml)

Request

https://joturl.com/a/i1/jotbars/property?context=user&format=xml

Query parameters

context = user
 format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <positions>right,left,top,bottom,empty</positions>  
    <dimensions>small,medium,big</dimensions>  
  </result>  
</response>

Example 11 (txt)

Request

https://joturl.com/a/i1/jotbars/property?context=user&format=txt

Query parameters

context = user
 format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_positions=right,left,top,bottom,empty
result_dimensions=small,medium,big

Example 12 (plain)

Request

https://joturl.com/a/i1/jotbars/property?context=user&format=plain

Query parameters

context = user
 format = plain

Response

right,left,top,bottom,empty
small,medium,big
Required parameters
parameterdescription
contextSTRINGit can be url, project or user and specifies the context for which positions and dimensions are requested
Return values
parameterdescription
dimensionscomma separated list of dimensions for the context, available dimensions: big, inherit, medium, small
positionscomma separated list of positions for context, available positions: bottom, empty, inherit, left, right, top

/locations

/locations/list

access: [READ]

This method returns a list of available locations.

Example 1 (json)

Request

https://joturl.com/a/i1/locations/list

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "locations": [
      {
        "label": "Afghanistan (\u0627\u0641\u063a\u0627\u0646\u0633\u062a\u0627\u0646)",
        "code": "AF"
      },
      {
        "label": "Aland Islands",
        "code": "AX"
      },
      {
        "label": "Albania (Shqipëria)",
        "code": "AL"
      },
      {
        "label": "Algeria (\u0627\u0644\u062c\u0632\u0627\u0626\u0631)",
        "code": "DZ"
      },
      {
        "label": "American Samoa",
        "code": "AS"
      },
      {
        "label": "Andorra",
        "code": "AD"
      },
      {
        "label": "Angola",
        "code": "AO"
      },
      {
        "label": "Anguilla",
        "code": "AI"
      },
      {
        "label": "Antarctica",
        "code": "AQ"
      },
      {
        "label": "Antigua and Barbuda",
        "code": "AG"
      },
      {
        "label": "Argentina",
        "code": "AR"
      },
      {
        "label": "Armenia (\u0540\u0561\u0575\u0561\u057d\u057f\u0561\u0576)",
        "code": "AM"
      },
      {
        "label": "Aruba",
        "code": "AW"
      },
      {
        "label": "Australia",
        "code": "AU"
      },
      {
        "label": "Austria (Österreich)",
        "code": "AT"
      },
      {
        "label": "Azerbaijan (Az\u0259rbaycan)",
        "code": "AZ"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/locations/list?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <locations>
      <i0>
        <label>Afghanistan (افغانستان)</label>  
        <code>AF</code>  
      </i0>  
      <i1>
        <label>Aland Islands</label>  
        <code>AX</code>  
      </i1>  
      <i2>
        <label><[CDATA[Albania (Shqip&euml;ria)]]></label>  
        <code>AL</code>  
      </i2>  
      <i3>
        <label>Algeria (الجزائر)</label>  
        <code>DZ</code>  
      </i3>  
      <i4>
        <label>American Samoa</label>  
        <code>AS</code>  
      </i4>  
      <i5>
        <label>Andorra</label>  
        <code>AD</code>  
      </i5>  
      <i6>
        <label>Angola</label>  
        <code>AO</code>  
      </i6>  
      <i7>
        <label>Anguilla</label>  
        <code>AI</code>  
      </i7>  
      <i8>
        <label>Antarctica</label>  
        <code>AQ</code>  
      </i8>  
      <i9>
        <label>Antigua and Barbuda</label>  
        <code>AG</code>  
      </i9>  
      <i10>
        <label>Argentina</label>  
        <code>AR</code>  
      </i10>  
      <i11>
        <label>Armenia (Հայաստան)</label>  
        <code>AM</code>  
      </i11>  
      <i12>
        <label>Aruba</label>  
        <code>AW</code>  
      </i12>  
      <i13>
        <label>Australia</label>  
        <code>AU</code>  
      </i13>  
      <i14>
        <label><[CDATA[Austria (&Ouml;sterreich)]]></label>  
        <code>AT</code>  
      </i14>  
      <i15>
        <label>Azerbaijan (Azərbaycan)</label>  
        <code>AZ</code>  
      </i15>  
    </locations>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/locations/list?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_locations_0_label=Afghanistan (افغانستان)
result_locations_0_code=AF
result_locations_1_label=Aland Islands
result_locations_1_code=AX
result_locations_2_label=Albania (Shqip&euml;ria)
result_locations_2_code=AL
result_locations_3_label=Algeria (الجزائر)
result_locations_3_code=DZ
result_locations_4_label=American Samoa
result_locations_4_code=AS
result_locations_5_label=Andorra
result_locations_5_code=AD
result_locations_6_label=Angola
result_locations_6_code=AO
result_locations_7_label=Anguilla
result_locations_7_code=AI
result_locations_8_label=Antarctica
result_locations_8_code=AQ
result_locations_9_label=Antigua and Barbuda
result_locations_9_code=AG
result_locations_10_label=Argentina
result_locations_10_code=AR
result_locations_11_label=Armenia (Հայաստան)
result_locations_11_code=AM
result_locations_12_label=Aruba
result_locations_12_code=AW
result_locations_13_label=Australia
result_locations_13_code=AU
result_locations_14_label=Austria (&Ouml;sterreich)
result_locations_14_code=AT
result_locations_15_label=Azerbaijan (Azərbaycan)
result_locations_15_code=AZ

Example 4 (plain)

Request

https://joturl.com/a/i1/locations/list?format=plain

Query parameters

format = plain

Response

Afghanistan (افغانستان)
AF
Aland Islands
AX
Albania (Shqip&euml;ria)
AL
Algeria (الجزائر)
DZ
American Samoa
AS
Andorra
AD
Angola
AO
Anguilla
AI
Antarctica
AQ
Antigua and Barbuda
AG
Argentina
AR
Armenia (Հայաստան)
AM
Aruba
AW
Australia
AU
Austria (&Ouml;sterreich)
AT
Azerbaijan (Azərbaycan)
AZ
Return values
parameterdescription
locationslist of available locations

/oauth

/oauth/access_token

access: [WRITE]

Get OAUTH 2.0 access token.

Example 1 (json)

Request

https://joturl.com/a/i1/oauth/access_token?grant_type=authorization_code&client_id=79582020ed9b1c8f0b9e55bc24ca17fc&client_secret=c209be8d4f3c06c4e988371d850acf8d&code=1ac434d335b6119435a2425eb8d1b5f6

Query parameters

   grant_type = authorization_code
    client_id = 79582020ed9b1c8f0b9e55bc24ca17fc
client_secret = c209be8d4f3c06c4e988371d850acf8d
         code = 1ac434d335b6119435a2425eb8d1b5f6

Response

{
  "token_type": "bearer",
  "expires_in": 864000,
  "access_token": "69ab66402499e6b594a469b39913a3fa",
  "refresh_token": "9575301cb9f82258f7bab9a3ab3e81c7"
}

Example 2 (xml)

Request

https://joturl.com/a/i1/oauth/access_token?grant_type=authorization_code&client_id=79582020ed9b1c8f0b9e55bc24ca17fc&client_secret=c209be8d4f3c06c4e988371d850acf8d&code=1ac434d335b6119435a2425eb8d1b5f6&format=xml

Query parameters

   grant_type = authorization_code
    client_id = 79582020ed9b1c8f0b9e55bc24ca17fc
client_secret = c209be8d4f3c06c4e988371d850acf8d
         code = 1ac434d335b6119435a2425eb8d1b5f6
       format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <token_type>bearer</token_type>  
  <expires_in>864000</expires_in>  
  <access_token>69ab66402499e6b594a469b39913a3fa</access_token>  
  <refresh_token>9575301cb9f82258f7bab9a3ab3e81c7</refresh_token>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/oauth/access_token?grant_type=authorization_code&client_id=79582020ed9b1c8f0b9e55bc24ca17fc&client_secret=c209be8d4f3c06c4e988371d850acf8d&code=1ac434d335b6119435a2425eb8d1b5f6&format=txt

Query parameters

   grant_type = authorization_code
    client_id = 79582020ed9b1c8f0b9e55bc24ca17fc
client_secret = c209be8d4f3c06c4e988371d850acf8d
         code = 1ac434d335b6119435a2425eb8d1b5f6
       format = txt

Response

token_type=bearer
expires_in=864000
access_token=69ab66402499e6b594a469b39913a3fa
refresh_token=9575301cb9f82258f7bab9a3ab3e81c7

Example 4 (plain)

Request

https://joturl.com/a/i1/oauth/access_token?grant_type=authorization_code&client_id=79582020ed9b1c8f0b9e55bc24ca17fc&client_secret=c209be8d4f3c06c4e988371d850acf8d&code=1ac434d335b6119435a2425eb8d1b5f6&format=plain

Query parameters

   grant_type = authorization_code
    client_id = 79582020ed9b1c8f0b9e55bc24ca17fc
client_secret = c209be8d4f3c06c4e988371d850acf8d
         code = 1ac434d335b6119435a2425eb8d1b5f6
       format = plain

Response

bearer
864000
69ab66402499e6b594a469b39913a3fa
9575301cb9f82258f7bab9a3ab3e81c7
Required parameters
parameterdescription
client_idSTRINGis the public identifier for the app
client_secretSTRINGsecret identifier for the app for mode = secret (see i1/oauth/authorize) or the nonce for mode = secretless (see i1/oauth/authorize)
grant_typeSTRINGrequested authorization type, supported grand types: authorization_code, refresh_token
Optional parameters
parameterdescription
codeSTRINGthe code returned from the authorization flow, this parameter is mandatory if grant_type = authorization_code
refresh_tokenSTRINGrefresh token returned by this method in the authorization flow, this parameter is mandatory if grant_type = refresh_token
std_errorsBOOLEAN1 to return standard OAuth 2.0 errors, otherwise errors that respect this documentation will be returned (default: 0 for backward compatibility, this will be changed in the near future, so it is advisable to use std_errors = 1
Return values
parameterdescription
access_tokenthe access token string as issued by the authorization flow
expires_inthe duration of time (in seconds) the access token is granted for
nonceit is returned only if mode = secretless is passed in the request to i1/oauth/authorize and must be used to call all successive calls to JotUrl's APIs, its value is temporary and must be used within few minutes
refresh_tokenthe refresh token can be used to obtain another access token after the issued one has expired, this token is empty if mode = secretless is passed to i1/oauth/authorize
token_typeThe type of token this is, it is just the string bearer

/oauth/authorize

access: [WRITE]

OAUTH 2.0 Authorization.

Example 1 (json)

Request

https://joturl.com/a/i1/oauth/authorize?response_type=code&client_id=637293b8bd65f6195323c0b491bdca7c&redirect_uri=https%3A%2F%2Fwww.joturl.com%2F&scope=rw&state=2ef2318b78ada3d4b986b6a7d1f5c3f8

Query parameters

response_type = code
    client_id = 637293b8bd65f6195323c0b491bdca7c
 redirect_uri = https://www.joturl.com/
        scope = rw
        state = 2ef2318b78ada3d4b986b6a7d1f5c3f8

Response

{
  "code": "1135966c35730858fb97c256de6f20b8",
  "state": "2ef2318b78ada3d4b986b6a7d1f5c3f8",
  "mode": "secret"
}

Example 2 (xml)

Request

https://joturl.com/a/i1/oauth/authorize?response_type=code&client_id=637293b8bd65f6195323c0b491bdca7c&redirect_uri=https%3A%2F%2Fwww.joturl.com%2F&scope=rw&state=2ef2318b78ada3d4b986b6a7d1f5c3f8&format=xml

Query parameters

response_type = code
    client_id = 637293b8bd65f6195323c0b491bdca7c
 redirect_uri = https://www.joturl.com/
        scope = rw
        state = 2ef2318b78ada3d4b986b6a7d1f5c3f8
       format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <code>1135966c35730858fb97c256de6f20b8</code>  
  <state>2ef2318b78ada3d4b986b6a7d1f5c3f8</state>  
  <mode>secret</mode>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/oauth/authorize?response_type=code&client_id=637293b8bd65f6195323c0b491bdca7c&redirect_uri=https%3A%2F%2Fwww.joturl.com%2F&scope=rw&state=2ef2318b78ada3d4b986b6a7d1f5c3f8&format=txt

Query parameters

response_type = code
    client_id = 637293b8bd65f6195323c0b491bdca7c
 redirect_uri = https://www.joturl.com/
        scope = rw
        state = 2ef2318b78ada3d4b986b6a7d1f5c3f8
       format = txt

Response

code=1135966c35730858fb97c256de6f20b8
state=2ef2318b78ada3d4b986b6a7d1f5c3f8
mode=secret

Example 4 (plain)

Request

https://joturl.com/a/i1/oauth/authorize?response_type=code&client_id=637293b8bd65f6195323c0b491bdca7c&redirect_uri=https%3A%2F%2Fwww.joturl.com%2F&scope=rw&state=2ef2318b78ada3d4b986b6a7d1f5c3f8&format=plain

Query parameters

response_type = code
    client_id = 637293b8bd65f6195323c0b491bdca7c
 redirect_uri = https://www.joturl.com/
        scope = rw
        state = 2ef2318b78ada3d4b986b6a7d1f5c3f8
       format = plain

Response

1135966c35730858fb97c256de6f20b8
2ef2318b78ada3d4b986b6a7d1f5c3f8
secret
Required parameters
parameterdescription
client_idSTRINGis the public identifier for the app
redirect_uriSTRINGtells the authorization server where to send the user back to after they approve the request
response_typeSTRINGhave be set to code, indicating that the application expects to receive an authorization code if successful.
scopeSTRINGone or more space-separated strings indicating which permissions the application is requesting, supported scopes are: rw = read/write access
stateSTRINGthis parameter is used to prevent CSRF attacks
Optional parameters
parameterdescription
modeSTRINGcan be secret to use the OAuth 2.0 flow that requires server-to-server communications or secretless for the flow that does not require the client secret (default: secret)
std_errorsBOOLEAN1 to return standard OAuth 2.0 errors, otherwise errors that respect this documentation will be returned (default: 0 for backward compatibility, this will be changed in the near future, so it is advisable to use std_errors = 1
Return values
parameterdescription
[NODATA]this method does not return any data but redirects to the OAuth 2.0 server to complete the OAuth 2.0 flow

/oauth/check

access: [WRITE]

Checks if an OAuth 2.0 Authorization was requested.

Example 1 (json)

Request

https://joturl.com/a/i1/oauth/check

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "3c07e105fbe2475e89d2f73b70861d0c",
    "app_name": "OAuth 2.0 App Name",
    "app_logo": "https:\/\/www.joturl.com\/reserved\/res\/ju2.0\/img\/header\/logo.svg",
    "redirect_url": "https:\/\/redirect.to\/?code=4f49dfea788f0ca9f0f7a223a575811b&state=1e4338762a748a58e9390a9367266acc&mode=secret"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/oauth/check?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>3c07e105fbe2475e89d2f73b70861d0c</id>  
    <app_name>OAuth 2.0 App Name</app_name>  
    <app_logo>https://www.joturl.com/reserved/res/ju2.0/img/header/logo.svg</app_logo>  
    <redirect_url><[CDATA[https://redirect.to/?code=4f49dfea788f0ca9f0f7a223a575811b&amp;state=1e4338762a748a58e9390a9367266acc&amp;mode=secret]]></redirect_url>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/oauth/check?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=3c07e105fbe2475e89d2f73b70861d0c
result_app_name=OAuth 2.0 App Name
result_app_logo=https://www.joturl.com/reserved/res/ju2.0/img/header/logo.svg
result_redirect_url=https://redirect.to/?code=4f49dfea788f0ca9f0f7a223a575811b&amp;state=1e4338762a748a58e9390a9367266acc&amp;mode=secret

Example 4 (plain)

Request

https://joturl.com/a/i1/oauth/check?format=plain

Query parameters

format = plain

Response

3c07e105fbe2475e89d2f73b70861d0c
OAuth 2.0 App Name
https://www.joturl.com/reserved/res/ju2.0/img/header/logo.svg
https://redirect.to/?code=4f49dfea788f0ca9f0f7a223a575811b&amp;state=1e4338762a748a58e9390a9367266acc&amp;mode=secret
Return values
parameterdescription
app_logothe URL to the logo of the application, empty if no authorization request has been made
app_namethe name of the OAuth 2.0 application, empty if no authorization request has been made
idthe ID of the OAuth 2.0 application, empty if no authorization request has been made
nonce[OPTIONAL] it is returned only if mode = secretless is passed in the request to i1/oauth/authorize
redirect_urlit has the same value passed in the request to i1/oauth/authorize with parameters code, state and mode appended, empty if no authorization request has been made

/oauth/granted

/oauth/granted/count

access: [READ]

This method returns the number of granted OAuth 2.0 clients.

Example 1 (json)

Request

https://joturl.com/a/i1/oauth/granted/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 5
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/oauth/granted/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>5</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/oauth/granted/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=5

Example 4 (plain)

Request

https://joturl.com/a/i1/oauth/granted/count?format=plain

Query parameters

format = plain

Response

5
Optional parameters
parameterdescription
searchSTRINGcount OAuth 2.0 clients by searching them
Return values
parameterdescription
countnumber of OAuth 2.0 clients the user has granted access to (filtered by search if passed)

/oauth/granted/list

access: [READ]

This method returns a list of granted OAuth 2.0 clients.

Example 1 (json)

Request

https://joturl.com/a/i1/oauth/granted/list

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": [
      {
        "app_name": "OAuth 2.0 Client Name",
        "app_logo": "https:\/\/oauth.client\/logo.png"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/oauth/granted/list?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <i0>
        <app_name>OAuth 2.0 Client Name</app_name>  
        <app_logo>https://oauth.client/logo.png</app_logo>  
      </i0>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/oauth/granted/list?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_0_app_name=OAuth 2.0 Client Name
result_data_0_app_logo=https://oauth.client/logo.png

Example 4 (plain)

Request

https://joturl.com/a/i1/oauth/granted/list?format=plain

Query parameters

format = plain

Response

OAuth 2.0 Client Name
https://oauth.client/logo.png
Optional parameters
parameterdescription
lengthINTEGERextracts this number of items (maxmimum allowed: 100)
orderbyARRAYorders items by field
searchSTRINGfilters items to be extracted by searching them
sortSTRINGsorts items in ascending (ASC) or descending (DESC) order
startINTEGERstarts to extract items from this position
Return values
parameterdescription
counttotal number of OAuth 2.0 clients
dataarray containing required information on clients the user has granted access to

/oauth/granted/revoke

access: [WRITE]

Revoke granted access to OAuth 2.0 clients.

Example 1 (json)

Request

https://joturl.com/a/i1/oauth/granted/revoke?ids=d3d9446802a44259755d38e6d163e820,3644a684f98ea8fe223c713b77189a77,e93028bdc1aacdfb3687181f2031765d

Query parameters

ids = d3d9446802a44259755d38e6d163e820,3644a684f98ea8fe223c713b77189a77,e93028bdc1aacdfb3687181f2031765d

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 3
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/oauth/granted/revoke?ids=d3d9446802a44259755d38e6d163e820,3644a684f98ea8fe223c713b77189a77,e93028bdc1aacdfb3687181f2031765d&format=xml

Query parameters

   ids = d3d9446802a44259755d38e6d163e820,3644a684f98ea8fe223c713b77189a77,e93028bdc1aacdfb3687181f2031765d
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>3</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/oauth/granted/revoke?ids=d3d9446802a44259755d38e6d163e820,3644a684f98ea8fe223c713b77189a77,e93028bdc1aacdfb3687181f2031765d&format=txt

Query parameters

   ids = d3d9446802a44259755d38e6d163e820,3644a684f98ea8fe223c713b77189a77,e93028bdc1aacdfb3687181f2031765d
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=3

Example 4 (plain)

Request

https://joturl.com/a/i1/oauth/granted/revoke?ids=d3d9446802a44259755d38e6d163e820,3644a684f98ea8fe223c713b77189a77,e93028bdc1aacdfb3687181f2031765d&format=plain

Query parameters

   ids = d3d9446802a44259755d38e6d163e820,3644a684f98ea8fe223c713b77189a77,e93028bdc1aacdfb3687181f2031765d
format = plain

Response

3

Example 5 (json)

Request

https://joturl.com/a/i1/oauth/granted/revoke?ids=1bd69c7df3112fb9a584fbd9edfc6c90,1017bfd4673955ffee4641ad3d481b1c,14ee22eaba297944c96afdbe5b16c65b

Query parameters

ids = 1bd69c7df3112fb9a584fbd9edfc6c90,1017bfd4673955ffee4641ad3d481b1c,14ee22eaba297944c96afdbe5b16c65b

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "ids": "1017bfd4673955ffee4641ad3d481b1c,14ee22eaba297944c96afdbe5b16c65b",
    "deleted": 1
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/oauth/granted/revoke?ids=1bd69c7df3112fb9a584fbd9edfc6c90,1017bfd4673955ffee4641ad3d481b1c,14ee22eaba297944c96afdbe5b16c65b&format=xml

Query parameters

   ids = 1bd69c7df3112fb9a584fbd9edfc6c90,1017bfd4673955ffee4641ad3d481b1c,14ee22eaba297944c96afdbe5b16c65b
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <ids>1017bfd4673955ffee4641ad3d481b1c,14ee22eaba297944c96afdbe5b16c65b</ids>  
    <deleted>1</deleted>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/oauth/granted/revoke?ids=1bd69c7df3112fb9a584fbd9edfc6c90,1017bfd4673955ffee4641ad3d481b1c,14ee22eaba297944c96afdbe5b16c65b&format=txt

Query parameters

   ids = 1bd69c7df3112fb9a584fbd9edfc6c90,1017bfd4673955ffee4641ad3d481b1c,14ee22eaba297944c96afdbe5b16c65b
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_ids=1017bfd4673955ffee4641ad3d481b1c,14ee22eaba297944c96afdbe5b16c65b
result_deleted=1

Example 8 (plain)

Request

https://joturl.com/a/i1/oauth/granted/revoke?ids=1bd69c7df3112fb9a584fbd9edfc6c90,1017bfd4673955ffee4641ad3d481b1c,14ee22eaba297944c96afdbe5b16c65b&format=plain

Query parameters

   ids = 1bd69c7df3112fb9a584fbd9edfc6c90,1017bfd4673955ffee4641ad3d481b1c,14ee22eaba297944c96afdbe5b16c65b
format = plain

Response

1017bfd4673955ffee4641ad3d481b1c,14ee22eaba297944c96afdbe5b16c65b
1
Required parameters
parameterdescription
idsARRAY_OF_IDScomma separated list of OAuth 2.0 client IDs to be revoked
Return values
parameterdescription
deletednumber of revoked OAuth 2.0 clients
ids[OPTIONAL] list of OAuth 2.0 client IDs whose revoke has failed, this parameter is returned only when at least one revoke error has occurred

/oauth/test

access: [WRITE]

Call this endpoint to test OAuth 2.0 authentication credentials.

Example 1 (json)

Request

https://joturl.com/a/i1/oauth/test

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "success": "1"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/oauth/test?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <success>1</success>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/oauth/test?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_success=1

Example 4 (plain)

Request

https://joturl.com/a/i1/oauth/test?format=plain

Query parameters

format = plain

Response

1
Optional parameters
parameterdescription
std_errorsBOOLEAN1 to return standard OAuth 2.0 errors, otherwise errors that respect this documentation will be returned (default: 0 for backward compatibility, this will be changed in the near future, so it is advisable to use std_errors = 1
Return values
parameterdescription
success1 on success, otherwise an authentication error is returned

/permissions

/permissions/add

access: [WRITE]

Define a new permission.

Example 1 (json)

Request

https://joturl.com/a/i1/permissions/add?name=name+of+the+permission&info=%7B%22apis%22%3A%7B%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22conversions%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22can_link%22%3A1,%22can_unlink%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22ctas%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22can_link%22%3A1,%22can_unlink%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22domains%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D,%22all_except%22%3A%5B%229ae968423fa3d75f3aa47f7ee156e47b%22,%22697bc4bfd54a41961f58d084fccb3f9c%22%5D%7D,%22plans%22%3A%7B%22can_manage_plans%22%3A0,%22can_manage_billing%22%3A0%7D,%22projects%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22access_to_default%22%3A1%7D,%22remarketings%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22can_link%22%3A1,%22can_unlink%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22security%22%3A%7B%22inactivity_timeout%22%3A0,%22inactivity_timeout_value%22%3A15,%22force_change_password%22%3A0,%22force_change_password_interval%22%3A3,%22do_not_allow_old_passwords%22%3A0,%22do_not_allow_old_passwords_value%22%3A4,%22disable_inactive_account%22%3A0,%22disable_inactive_account_value%22%3A6,%22warning_on_anomalous_logins%22%3A0%7D,%22subusers%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1%7D%7D

Query parameters

name = name of the permission
info = {"apis":{"access_to":{"all_except":[]}},"conversions":{"can_add":1,"can_edit":1,"can_delete":1,"can_link":1,"can_unlink":1,"access_to":{"all_except":[]}},"ctas":{"can_add":1,"can_edit":1,"can_delete":1,"can_link":1,"can_unlink":1,"access_to":{"all_except":[]}},"domains":{"can_add":1,"can_edit":1,"can_delete":1,"access_to":{"all_except":[]},"all_except":["9ae968423fa3d75f3aa47f7ee156e47b","697bc4bfd54a41961f58d084fccb3f9c"]},"plans":{"can_manage_plans":0,"can_manage_billing":0},"projects":{"can_add":1,"can_edit":1,"can_delete":1,"access_to_default":1},"remarketings":{"can_add":1,"can_edit":1,"can_delete":1,"can_link":1,"can_unlink":1,"access_to":{"all_except":[]}},"security":{"inactivity_timeout":0,"inactivity_timeout_value":15,"force_change_password":0,"force_change_password_interval":3,"do_not_allow_old_passwords":0,"do_not_allow_old_passwords_value":4,"disable_inactive_account":0,"disable_inactive_account_value":6,"warning_on_anomalous_logins":0},"subusers":{"can_add":1,"can_edit":1,"can_delete":1}}

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "64052e0608f8fb83bc4265b7cb90b9bf",
    "name": "name of the permission",
    "notes": "",
    "info": {
      "apis": {
        "access_to": {
          "all_except": []
        }
      },
      "conversions": {
        "can_add": 1,
        "can_edit": 1,
        "can_delete": 1,
        "can_link": 1,
        "can_unlink": 1,
        "access_to": {
          "all_except": []
        }
      },
      "ctas": {
        "can_add": 1,
        "can_edit": 1,
        "can_delete": 1,
        "can_link": 1,
        "can_unlink": 1,
        "access_to": {
          "all_except": []
        }
      },
      "domains": {
        "can_add": 1,
        "can_edit": 1,
        "can_delete": 1,
        "access_to": {
          "all_except": []
        },
        "all_except": [
          {
            "id": "9ae968423fa3d75f3aa47f7ee156e47b",
            "name": "domain_0"
          },
          {
            "id": "697bc4bfd54a41961f58d084fccb3f9c",
            "name": "domain_1"
          }
        ]
      },
      "plans": {
        "can_manage_plans": 0,
        "can_manage_billing": 0
      },
      "projects": {
        "can_add": 1,
        "can_edit": 1,
        "can_delete": 1,
        "access_to_default": 1
      },
      "remarketings": {
        "can_add": 1,
        "can_edit": 1,
        "can_delete": 1,
        "can_link": 1,
        "can_unlink": 1,
        "access_to": {
          "all_except": []
        }
      },
      "security": {
        "inactivity_timeout": 0,
        "inactivity_timeout_value": 15,
        "force_change_password": 0,
        "force_change_password_interval": 3,
        "do_not_allow_old_passwords": 0,
        "do_not_allow_old_passwords_value": 4,
        "disable_inactive_account": 0,
        "disable_inactive_account_value": 6,
        "warning_on_anomalous_logins": 0
      },
      "subusers": {
        "can_add": 1,
        "can_edit": 1,
        "can_delete": 1
      }
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/permissions/add?name=name+of+the+permission&info=%7B%22apis%22%3A%7B%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22conversions%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22can_link%22%3A1,%22can_unlink%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22ctas%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22can_link%22%3A1,%22can_unlink%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22domains%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D,%22all_except%22%3A%5B%229ae968423fa3d75f3aa47f7ee156e47b%22,%22697bc4bfd54a41961f58d084fccb3f9c%22%5D%7D,%22plans%22%3A%7B%22can_manage_plans%22%3A0,%22can_manage_billing%22%3A0%7D,%22projects%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22access_to_default%22%3A1%7D,%22remarketings%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22can_link%22%3A1,%22can_unlink%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22security%22%3A%7B%22inactivity_timeout%22%3A0,%22inactivity_timeout_value%22%3A15,%22force_change_password%22%3A0,%22force_change_password_interval%22%3A3,%22do_not_allow_old_passwords%22%3A0,%22do_not_allow_old_passwords_value%22%3A4,%22disable_inactive_account%22%3A0,%22disable_inactive_account_value%22%3A6,%22warning_on_anomalous_logins%22%3A0%7D,%22subusers%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1%7D%7D&format=xml

Query parameters

  name = name of the permission
  info = {"apis":{"access_to":{"all_except":[]}},"conversions":{"can_add":1,"can_edit":1,"can_delete":1,"can_link":1,"can_unlink":1,"access_to":{"all_except":[]}},"ctas":{"can_add":1,"can_edit":1,"can_delete":1,"can_link":1,"can_unlink":1,"access_to":{"all_except":[]}},"domains":{"can_add":1,"can_edit":1,"can_delete":1,"access_to":{"all_except":[]},"all_except":["9ae968423fa3d75f3aa47f7ee156e47b","697bc4bfd54a41961f58d084fccb3f9c"]},"plans":{"can_manage_plans":0,"can_manage_billing":0},"projects":{"can_add":1,"can_edit":1,"can_delete":1,"access_to_default":1},"remarketings":{"can_add":1,"can_edit":1,"can_delete":1,"can_link":1,"can_unlink":1,"access_to":{"all_except":[]}},"security":{"inactivity_timeout":0,"inactivity_timeout_value":15,"force_change_password":0,"force_change_password_interval":3,"do_not_allow_old_passwords":0,"do_not_allow_old_passwords_value":4,"disable_inactive_account":0,"disable_inactive_account_value":6,"warning_on_anomalous_logins":0},"subusers":{"can_add":1,"can_edit":1,"can_delete":1}}
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>64052e0608f8fb83bc4265b7cb90b9bf</id>  
    <name>name of the permission</name>  
    <notes></notes>  
    <info>
      <apis>
        <access_to>
          <all_except>

          </all_except>  
        </access_to>  
      </apis>  
      <conversions>
        <can_add>1</can_add>  
        <can_edit>1</can_edit>  
        <can_delete>1</can_delete>  
        <can_link>1</can_link>  
        <can_unlink>1</can_unlink>  
        <access_to>
          <all_except>

          </all_except>  
        </access_to>  
      </conversions>  
      <ctas>
        <can_add>1</can_add>  
        <can_edit>1</can_edit>  
        <can_delete>1</can_delete>  
        <can_link>1</can_link>  
        <can_unlink>1</can_unlink>  
        <access_to>
          <all_except>

          </all_except>  
        </access_to>  
      </ctas>  
      <domains>
        <can_add>1</can_add>  
        <can_edit>1</can_edit>  
        <can_delete>1</can_delete>  
        <access_to>
          <all_except>

          </all_except>  
        </access_to>  
        <all_except>
          <i0>
            <id>9ae968423fa3d75f3aa47f7ee156e47b</id>  
            <name>domain_0</name>  
          </i0>  
          <i1>
            <id>697bc4bfd54a41961f58d084fccb3f9c</id>  
            <name>domain_1</name>  
          </i1>  
        </all_except>  
      </domains>  
      <plans>
        <can_manage_plans>0</can_manage_plans>  
        <can_manage_billing>0</can_manage_billing>  
      </plans>  
      <projects>
        <can_add>1</can_add>  
        <can_edit>1</can_edit>  
        <can_delete>1</can_delete>  
        <access_to_default>1</access_to_default>  
      </projects>  
      <remarketings>
        <can_add>1</can_add>  
        <can_edit>1</can_edit>  
        <can_delete>1</can_delete>  
        <can_link>1</can_link>  
        <can_unlink>1</can_unlink>  
        <access_to>
          <all_except>

          </all_except>  
        </access_to>  
      </remarketings>  
      <security>
        <inactivity_timeout>0</inactivity_timeout>  
        <inactivity_timeout_value>15</inactivity_timeout_value>  
        <force_change_password>0</force_change_password>  
        <force_change_password_interval>3</force_change_password_interval>  
        <do_not_allow_old_passwords>0</do_not_allow_old_passwords>  
        <do_not_allow_old_passwords_value>4</do_not_allow_old_passwords_value>  
        <disable_inactive_account>0</disable_inactive_account>  
        <disable_inactive_account_value>6</disable_inactive_account_value>  
        <warning_on_anomalous_logins>0</warning_on_anomalous_logins>  
      </security>  
      <subusers>
        <can_add>1</can_add>  
        <can_edit>1</can_edit>  
        <can_delete>1</can_delete>  
      </subusers>  
    </info>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/permissions/add?name=name+of+the+permission&info=%7B%22apis%22%3A%7B%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22conversions%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22can_link%22%3A1,%22can_unlink%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22ctas%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22can_link%22%3A1,%22can_unlink%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22domains%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D,%22all_except%22%3A%5B%229ae968423fa3d75f3aa47f7ee156e47b%22,%22697bc4bfd54a41961f58d084fccb3f9c%22%5D%7D,%22plans%22%3A%7B%22can_manage_plans%22%3A0,%22can_manage_billing%22%3A0%7D,%22projects%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22access_to_default%22%3A1%7D,%22remarketings%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22can_link%22%3A1,%22can_unlink%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22security%22%3A%7B%22inactivity_timeout%22%3A0,%22inactivity_timeout_value%22%3A15,%22force_change_password%22%3A0,%22force_change_password_interval%22%3A3,%22do_not_allow_old_passwords%22%3A0,%22do_not_allow_old_passwords_value%22%3A4,%22disable_inactive_account%22%3A0,%22disable_inactive_account_value%22%3A6,%22warning_on_anomalous_logins%22%3A0%7D,%22subusers%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1%7D%7D&format=txt

Query parameters

  name = name of the permission
  info = {"apis":{"access_to":{"all_except":[]}},"conversions":{"can_add":1,"can_edit":1,"can_delete":1,"can_link":1,"can_unlink":1,"access_to":{"all_except":[]}},"ctas":{"can_add":1,"can_edit":1,"can_delete":1,"can_link":1,"can_unlink":1,"access_to":{"all_except":[]}},"domains":{"can_add":1,"can_edit":1,"can_delete":1,"access_to":{"all_except":[]},"all_except":["9ae968423fa3d75f3aa47f7ee156e47b","697bc4bfd54a41961f58d084fccb3f9c"]},"plans":{"can_manage_plans":0,"can_manage_billing":0},"projects":{"can_add":1,"can_edit":1,"can_delete":1,"access_to_default":1},"remarketings":{"can_add":1,"can_edit":1,"can_delete":1,"can_link":1,"can_unlink":1,"access_to":{"all_except":[]}},"security":{"inactivity_timeout":0,"inactivity_timeout_value":15,"force_change_password":0,"force_change_password_interval":3,"do_not_allow_old_passwords":0,"do_not_allow_old_passwords_value":4,"disable_inactive_account":0,"disable_inactive_account_value":6,"warning_on_anomalous_logins":0},"subusers":{"can_add":1,"can_edit":1,"can_delete":1}}
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=64052e0608f8fb83bc4265b7cb90b9bf
result_name=name of the permission
result_notes=
result_info_apis_access_to_all_except=
result_info_conversions_can_add=1
result_info_conversions_can_edit=1
result_info_conversions_can_delete=1
result_info_conversions_can_link=1
result_info_conversions_can_unlink=1
result_info_conversions_access_to_all_except=
result_info_ctas_can_add=1
result_info_ctas_can_edit=1
result_info_ctas_can_delete=1
result_info_ctas_can_link=1
result_info_ctas_can_unlink=1
result_info_ctas_access_to_all_except=
result_info_domains_can_add=1
result_info_domains_can_edit=1
result_info_domains_can_delete=1
result_info_domains_access_to_all_except=
result_info_domains_all_except_0_id=9ae968423fa3d75f3aa47f7ee156e47b
result_info_domains_all_except_0_name=domain_0
result_info_domains_all_except_1_id=697bc4bfd54a41961f58d084fccb3f9c
result_info_domains_all_except_1_name=domain_1
result_info_plans_can_manage_plans=0
result_info_plans_can_manage_billing=0
result_info_projects_can_add=1
result_info_projects_can_edit=1
result_info_projects_can_delete=1
result_info_projects_access_to_default=1
result_info_remarketings_can_add=1
result_info_remarketings_can_edit=1
result_info_remarketings_can_delete=1
result_info_remarketings_can_link=1
result_info_remarketings_can_unlink=1
result_info_remarketings_access_to_all_except=
result_info_security_inactivity_timeout=0
result_info_security_inactivity_timeout_value=15
result_info_security_force_change_password=0
result_info_security_force_change_password_interval=3
result_info_security_do_not_allow_old_passwords=0
result_info_security_do_not_allow_old_passwords_value=4
result_info_security_disable_inactive_account=0
result_info_security_disable_inactive_account_value=6
result_info_security_warning_on_anomalous_logins=0
result_info_subusers_can_add=1
result_info_subusers_can_edit=1
result_info_subusers_can_delete=1

Example 4 (plain)

Request

https://joturl.com/a/i1/permissions/add?name=name+of+the+permission&info=%7B%22apis%22%3A%7B%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22conversions%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22can_link%22%3A1,%22can_unlink%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22ctas%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22can_link%22%3A1,%22can_unlink%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22domains%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D,%22all_except%22%3A%5B%229ae968423fa3d75f3aa47f7ee156e47b%22,%22697bc4bfd54a41961f58d084fccb3f9c%22%5D%7D,%22plans%22%3A%7B%22can_manage_plans%22%3A0,%22can_manage_billing%22%3A0%7D,%22projects%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22access_to_default%22%3A1%7D,%22remarketings%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22can_link%22%3A1,%22can_unlink%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22security%22%3A%7B%22inactivity_timeout%22%3A0,%22inactivity_timeout_value%22%3A15,%22force_change_password%22%3A0,%22force_change_password_interval%22%3A3,%22do_not_allow_old_passwords%22%3A0,%22do_not_allow_old_passwords_value%22%3A4,%22disable_inactive_account%22%3A0,%22disable_inactive_account_value%22%3A6,%22warning_on_anomalous_logins%22%3A0%7D,%22subusers%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1%7D%7D&format=plain

Query parameters

  name = name of the permission
  info = {"apis":{"access_to":{"all_except":[]}},"conversions":{"can_add":1,"can_edit":1,"can_delete":1,"can_link":1,"can_unlink":1,"access_to":{"all_except":[]}},"ctas":{"can_add":1,"can_edit":1,"can_delete":1,"can_link":1,"can_unlink":1,"access_to":{"all_except":[]}},"domains":{"can_add":1,"can_edit":1,"can_delete":1,"access_to":{"all_except":[]},"all_except":["9ae968423fa3d75f3aa47f7ee156e47b","697bc4bfd54a41961f58d084fccb3f9c"]},"plans":{"can_manage_plans":0,"can_manage_billing":0},"projects":{"can_add":1,"can_edit":1,"can_delete":1,"access_to_default":1},"remarketings":{"can_add":1,"can_edit":1,"can_delete":1,"can_link":1,"can_unlink":1,"access_to":{"all_except":[]}},"security":{"inactivity_timeout":0,"inactivity_timeout_value":15,"force_change_password":0,"force_change_password_interval":3,"do_not_allow_old_passwords":0,"do_not_allow_old_passwords_value":4,"disable_inactive_account":0,"disable_inactive_account_value":6,"warning_on_anomalous_logins":0},"subusers":{"can_add":1,"can_edit":1,"can_delete":1}}
format = plain

Response

64052e0608f8fb83bc4265b7cb90b9bf
name of the permission


1
1
1
1
1

1
1
1
1
1

1
1
1

9ae968423fa3d75f3aa47f7ee156e47b
domain_0
697bc4bfd54a41961f58d084fccb3f9c
domain_1
0
0
1
1
1
1
1
1
1
1
1

0
15
0
3
0
4
0
6
0
1
1
1
Required parameters
parameterdescriptionmax length
nameSTRINGname of the permission100
Optional parameters
parameterdescriptionmax length
infoJSONinformation on access rights, see i1/permissions/property for details
notesSTRINGnotes for the permission255
Return values
parameterdescription
idID of the permission
infoinformation on access rights
nameecho back of the input parameter name
notesecho back of the input parameter notes

/permissions/count

access: [READ]

This method returns the number of user's permissions.

Example 1 (json)

Request

https://joturl.com/a/i1/permissions/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 45
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/permissions/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>45</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/permissions/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=45

Example 4 (plain)

Request

https://joturl.com/a/i1/permissions/count?format=plain

Query parameters

format = plain

Response

45

Example 5 (json)

Request

https://joturl.com/a/i1/permissions/count?search=test

Query parameters

search = test

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 31
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/permissions/count?search=test&format=xml

Query parameters

search = test
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>31</count>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/permissions/count?search=test&format=txt

Query parameters

search = test
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=31

Example 8 (plain)

Request

https://joturl.com/a/i1/permissions/count?search=test&format=plain

Query parameters

search = test
format = plain

Response

31
Optional parameters
parameterdescription
searchSTRINGcount permissions by searching them
Return values
parameterdescription
countnumber of permissions (filtered by search if passed)

/permissions/delete

access: [WRITE]

Delete one or more permissions.

Example 1 (json)

Request

https://joturl.com/a/i1/permissions/delete?ids=37693cfc748049e45d87b8c7d8b9aacd,e92ea2e30768f2fda96f7e9eba39c6eb,f569c3d708a7558b3049d2896d2b6ce1

Query parameters

ids = 37693cfc748049e45d87b8c7d8b9aacd,e92ea2e30768f2fda96f7e9eba39c6eb,f569c3d708a7558b3049d2896d2b6ce1

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 3
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/permissions/delete?ids=37693cfc748049e45d87b8c7d8b9aacd,e92ea2e30768f2fda96f7e9eba39c6eb,f569c3d708a7558b3049d2896d2b6ce1&format=xml

Query parameters

   ids = 37693cfc748049e45d87b8c7d8b9aacd,e92ea2e30768f2fda96f7e9eba39c6eb,f569c3d708a7558b3049d2896d2b6ce1
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>3</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/permissions/delete?ids=37693cfc748049e45d87b8c7d8b9aacd,e92ea2e30768f2fda96f7e9eba39c6eb,f569c3d708a7558b3049d2896d2b6ce1&format=txt

Query parameters

   ids = 37693cfc748049e45d87b8c7d8b9aacd,e92ea2e30768f2fda96f7e9eba39c6eb,f569c3d708a7558b3049d2896d2b6ce1
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=3

Example 4 (plain)

Request

https://joturl.com/a/i1/permissions/delete?ids=37693cfc748049e45d87b8c7d8b9aacd,e92ea2e30768f2fda96f7e9eba39c6eb,f569c3d708a7558b3049d2896d2b6ce1&format=plain

Query parameters

   ids = 37693cfc748049e45d87b8c7d8b9aacd,e92ea2e30768f2fda96f7e9eba39c6eb,f569c3d708a7558b3049d2896d2b6ce1
format = plain

Response

3

Example 5 (json)

Request

https://joturl.com/a/i1/permissions/delete?ids=2e0aca891f2a8aedf265edf533a6d9a8,3d324c2883882b15fa8fbe8f025a3a99,a330238f5e5026982abe38b8f2215898

Query parameters

ids = 2e0aca891f2a8aedf265edf533a6d9a8,3d324c2883882b15fa8fbe8f025a3a99,a330238f5e5026982abe38b8f2215898

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "ids": "3d324c2883882b15fa8fbe8f025a3a99,a330238f5e5026982abe38b8f2215898",
    "deleted": 1
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/permissions/delete?ids=2e0aca891f2a8aedf265edf533a6d9a8,3d324c2883882b15fa8fbe8f025a3a99,a330238f5e5026982abe38b8f2215898&format=xml

Query parameters

   ids = 2e0aca891f2a8aedf265edf533a6d9a8,3d324c2883882b15fa8fbe8f025a3a99,a330238f5e5026982abe38b8f2215898
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <ids>3d324c2883882b15fa8fbe8f025a3a99,a330238f5e5026982abe38b8f2215898</ids>  
    <deleted>1</deleted>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/permissions/delete?ids=2e0aca891f2a8aedf265edf533a6d9a8,3d324c2883882b15fa8fbe8f025a3a99,a330238f5e5026982abe38b8f2215898&format=txt

Query parameters

   ids = 2e0aca891f2a8aedf265edf533a6d9a8,3d324c2883882b15fa8fbe8f025a3a99,a330238f5e5026982abe38b8f2215898
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_ids=3d324c2883882b15fa8fbe8f025a3a99,a330238f5e5026982abe38b8f2215898
result_deleted=1

Example 8 (plain)

Request

https://joturl.com/a/i1/permissions/delete?ids=2e0aca891f2a8aedf265edf533a6d9a8,3d324c2883882b15fa8fbe8f025a3a99,a330238f5e5026982abe38b8f2215898&format=plain

Query parameters

   ids = 2e0aca891f2a8aedf265edf533a6d9a8,3d324c2883882b15fa8fbe8f025a3a99,a330238f5e5026982abe38b8f2215898
format = plain

Response

3d324c2883882b15fa8fbe8f025a3a99,a330238f5e5026982abe38b8f2215898
1
Required parameters
parameterdescription
idsARRAY_OF_IDScomma separated list of permission IDs to be deleted
Return values
parameterdescription
deletednumber of deleted permissions
ids[OPTIONAL] list of permission IDs whose delete has failed, this parameter is returned only when at least one delete error has occurred

/permissions/edit

access: [WRITE]

Edit a permission.

Example 1 (json)

Request

https://joturl.com/a/i1/permissions/edit?id=25c3f01d6ac693599cbc03d753826089&name=name+of+the+permission&info=%7B%22apis%22%3A%7B%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22conversions%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22can_link%22%3A1,%22can_unlink%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22ctas%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22can_link%22%3A1,%22can_unlink%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22domains%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D,%22all_except%22%3A%5B%22609f542eecb0b23d443080952528a3bd%22,%22d016798d2bf704129ca96df599a4ae76%22%5D%7D,%22plans%22%3A%7B%22can_manage_plans%22%3A0,%22can_manage_billing%22%3A0%7D,%22projects%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22access_to_default%22%3A1%7D,%22remarketings%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22can_link%22%3A1,%22can_unlink%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22security%22%3A%7B%22inactivity_timeout%22%3A0,%22inactivity_timeout_value%22%3A15,%22force_change_password%22%3A0,%22force_change_password_interval%22%3A3,%22do_not_allow_old_passwords%22%3A0,%22do_not_allow_old_passwords_value%22%3A4,%22disable_inactive_account%22%3A0,%22disable_inactive_account_value%22%3A6,%22warning_on_anomalous_logins%22%3A0%7D,%22subusers%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1%7D%7D

Query parameters

  id = 25c3f01d6ac693599cbc03d753826089
name = name of the permission
info = {"apis":{"access_to":{"all_except":[]}},"conversions":{"can_add":1,"can_edit":1,"can_delete":1,"can_link":1,"can_unlink":1,"access_to":{"all_except":[]}},"ctas":{"can_add":1,"can_edit":1,"can_delete":1,"can_link":1,"can_unlink":1,"access_to":{"all_except":[]}},"domains":{"can_add":1,"can_edit":1,"can_delete":1,"access_to":{"all_except":[]},"all_except":["609f542eecb0b23d443080952528a3bd","d016798d2bf704129ca96df599a4ae76"]},"plans":{"can_manage_plans":0,"can_manage_billing":0},"projects":{"can_add":1,"can_edit":1,"can_delete":1,"access_to_default":1},"remarketings":{"can_add":1,"can_edit":1,"can_delete":1,"can_link":1,"can_unlink":1,"access_to":{"all_except":[]}},"security":{"inactivity_timeout":0,"inactivity_timeout_value":15,"force_change_password":0,"force_change_password_interval":3,"do_not_allow_old_passwords":0,"do_not_allow_old_passwords_value":4,"disable_inactive_account":0,"disable_inactive_account_value":6,"warning_on_anomalous_logins":0},"subusers":{"can_add":1,"can_edit":1,"can_delete":1}}

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "25c3f01d6ac693599cbc03d753826089",
    "info": {
      "apis": {
        "access_to": {
          "all_except": []
        }
      },
      "conversions": {
        "can_add": 1,
        "can_edit": 1,
        "can_delete": 1,
        "can_link": 1,
        "can_unlink": 1,
        "access_to": {
          "all_except": []
        }
      },
      "ctas": {
        "can_add": 1,
        "can_edit": 1,
        "can_delete": 1,
        "can_link": 1,
        "can_unlink": 1,
        "access_to": {
          "all_except": []
        }
      },
      "domains": {
        "can_add": 1,
        "can_edit": 1,
        "can_delete": 1,
        "access_to": {
          "all_except": []
        },
        "all_except": [
          {
            "id": "609f542eecb0b23d443080952528a3bd",
            "name": "domain_0"
          },
          {
            "id": "d016798d2bf704129ca96df599a4ae76",
            "name": "domain_1"
          }
        ]
      },
      "plans": {
        "can_manage_plans": 0,
        "can_manage_billing": 0
      },
      "projects": {
        "can_add": 1,
        "can_edit": 1,
        "can_delete": 1,
        "access_to_default": 1
      },
      "remarketings": {
        "can_add": 1,
        "can_edit": 1,
        "can_delete": 1,
        "can_link": 1,
        "can_unlink": 1,
        "access_to": {
          "all_except": []
        }
      },
      "security": {
        "inactivity_timeout": 0,
        "inactivity_timeout_value": 15,
        "force_change_password": 0,
        "force_change_password_interval": 3,
        "do_not_allow_old_passwords": 0,
        "do_not_allow_old_passwords_value": 4,
        "disable_inactive_account": 0,
        "disable_inactive_account_value": 6,
        "warning_on_anomalous_logins": 0
      },
      "subusers": {
        "can_add": 1,
        "can_edit": 1,
        "can_delete": 1
      }
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/permissions/edit?id=25c3f01d6ac693599cbc03d753826089&name=name+of+the+permission&info=%7B%22apis%22%3A%7B%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22conversions%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22can_link%22%3A1,%22can_unlink%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22ctas%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22can_link%22%3A1,%22can_unlink%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22domains%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D,%22all_except%22%3A%5B%22609f542eecb0b23d443080952528a3bd%22,%22d016798d2bf704129ca96df599a4ae76%22%5D%7D,%22plans%22%3A%7B%22can_manage_plans%22%3A0,%22can_manage_billing%22%3A0%7D,%22projects%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22access_to_default%22%3A1%7D,%22remarketings%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22can_link%22%3A1,%22can_unlink%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22security%22%3A%7B%22inactivity_timeout%22%3A0,%22inactivity_timeout_value%22%3A15,%22force_change_password%22%3A0,%22force_change_password_interval%22%3A3,%22do_not_allow_old_passwords%22%3A0,%22do_not_allow_old_passwords_value%22%3A4,%22disable_inactive_account%22%3A0,%22disable_inactive_account_value%22%3A6,%22warning_on_anomalous_logins%22%3A0%7D,%22subusers%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1%7D%7D&format=xml

Query parameters

    id = 25c3f01d6ac693599cbc03d753826089
  name = name of the permission
  info = {"apis":{"access_to":{"all_except":[]}},"conversions":{"can_add":1,"can_edit":1,"can_delete":1,"can_link":1,"can_unlink":1,"access_to":{"all_except":[]}},"ctas":{"can_add":1,"can_edit":1,"can_delete":1,"can_link":1,"can_unlink":1,"access_to":{"all_except":[]}},"domains":{"can_add":1,"can_edit":1,"can_delete":1,"access_to":{"all_except":[]},"all_except":["609f542eecb0b23d443080952528a3bd","d016798d2bf704129ca96df599a4ae76"]},"plans":{"can_manage_plans":0,"can_manage_billing":0},"projects":{"can_add":1,"can_edit":1,"can_delete":1,"access_to_default":1},"remarketings":{"can_add":1,"can_edit":1,"can_delete":1,"can_link":1,"can_unlink":1,"access_to":{"all_except":[]}},"security":{"inactivity_timeout":0,"inactivity_timeout_value":15,"force_change_password":0,"force_change_password_interval":3,"do_not_allow_old_passwords":0,"do_not_allow_old_passwords_value":4,"disable_inactive_account":0,"disable_inactive_account_value":6,"warning_on_anomalous_logins":0},"subusers":{"can_add":1,"can_edit":1,"can_delete":1}}
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>25c3f01d6ac693599cbc03d753826089</id>  
    <info>
      <apis>
        <access_to>
          <all_except>

          </all_except>  
        </access_to>  
      </apis>  
      <conversions>
        <can_add>1</can_add>  
        <can_edit>1</can_edit>  
        <can_delete>1</can_delete>  
        <can_link>1</can_link>  
        <can_unlink>1</can_unlink>  
        <access_to>
          <all_except>

          </all_except>  
        </access_to>  
      </conversions>  
      <ctas>
        <can_add>1</can_add>  
        <can_edit>1</can_edit>  
        <can_delete>1</can_delete>  
        <can_link>1</can_link>  
        <can_unlink>1</can_unlink>  
        <access_to>
          <all_except>

          </all_except>  
        </access_to>  
      </ctas>  
      <domains>
        <can_add>1</can_add>  
        <can_edit>1</can_edit>  
        <can_delete>1</can_delete>  
        <access_to>
          <all_except>

          </all_except>  
        </access_to>  
        <all_except>
          <i0>
            <id>609f542eecb0b23d443080952528a3bd</id>  
            <name>domain_0</name>  
          </i0>  
          <i1>
            <id>d016798d2bf704129ca96df599a4ae76</id>  
            <name>domain_1</name>  
          </i1>  
        </all_except>  
      </domains>  
      <plans>
        <can_manage_plans>0</can_manage_plans>  
        <can_manage_billing>0</can_manage_billing>  
      </plans>  
      <projects>
        <can_add>1</can_add>  
        <can_edit>1</can_edit>  
        <can_delete>1</can_delete>  
        <access_to_default>1</access_to_default>  
      </projects>  
      <remarketings>
        <can_add>1</can_add>  
        <can_edit>1</can_edit>  
        <can_delete>1</can_delete>  
        <can_link>1</can_link>  
        <can_unlink>1</can_unlink>  
        <access_to>
          <all_except>

          </all_except>  
        </access_to>  
      </remarketings>  
      <security>
        <inactivity_timeout>0</inactivity_timeout>  
        <inactivity_timeout_value>15</inactivity_timeout_value>  
        <force_change_password>0</force_change_password>  
        <force_change_password_interval>3</force_change_password_interval>  
        <do_not_allow_old_passwords>0</do_not_allow_old_passwords>  
        <do_not_allow_old_passwords_value>4</do_not_allow_old_passwords_value>  
        <disable_inactive_account>0</disable_inactive_account>  
        <disable_inactive_account_value>6</disable_inactive_account_value>  
        <warning_on_anomalous_logins>0</warning_on_anomalous_logins>  
      </security>  
      <subusers>
        <can_add>1</can_add>  
        <can_edit>1</can_edit>  
        <can_delete>1</can_delete>  
      </subusers>  
    </info>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/permissions/edit?id=25c3f01d6ac693599cbc03d753826089&name=name+of+the+permission&info=%7B%22apis%22%3A%7B%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22conversions%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22can_link%22%3A1,%22can_unlink%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22ctas%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22can_link%22%3A1,%22can_unlink%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22domains%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D,%22all_except%22%3A%5B%22609f542eecb0b23d443080952528a3bd%22,%22d016798d2bf704129ca96df599a4ae76%22%5D%7D,%22plans%22%3A%7B%22can_manage_plans%22%3A0,%22can_manage_billing%22%3A0%7D,%22projects%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22access_to_default%22%3A1%7D,%22remarketings%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22can_link%22%3A1,%22can_unlink%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22security%22%3A%7B%22inactivity_timeout%22%3A0,%22inactivity_timeout_value%22%3A15,%22force_change_password%22%3A0,%22force_change_password_interval%22%3A3,%22do_not_allow_old_passwords%22%3A0,%22do_not_allow_old_passwords_value%22%3A4,%22disable_inactive_account%22%3A0,%22disable_inactive_account_value%22%3A6,%22warning_on_anomalous_logins%22%3A0%7D,%22subusers%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1%7D%7D&format=txt

Query parameters

    id = 25c3f01d6ac693599cbc03d753826089
  name = name of the permission
  info = {"apis":{"access_to":{"all_except":[]}},"conversions":{"can_add":1,"can_edit":1,"can_delete":1,"can_link":1,"can_unlink":1,"access_to":{"all_except":[]}},"ctas":{"can_add":1,"can_edit":1,"can_delete":1,"can_link":1,"can_unlink":1,"access_to":{"all_except":[]}},"domains":{"can_add":1,"can_edit":1,"can_delete":1,"access_to":{"all_except":[]},"all_except":["609f542eecb0b23d443080952528a3bd","d016798d2bf704129ca96df599a4ae76"]},"plans":{"can_manage_plans":0,"can_manage_billing":0},"projects":{"can_add":1,"can_edit":1,"can_delete":1,"access_to_default":1},"remarketings":{"can_add":1,"can_edit":1,"can_delete":1,"can_link":1,"can_unlink":1,"access_to":{"all_except":[]}},"security":{"inactivity_timeout":0,"inactivity_timeout_value":15,"force_change_password":0,"force_change_password_interval":3,"do_not_allow_old_passwords":0,"do_not_allow_old_passwords_value":4,"disable_inactive_account":0,"disable_inactive_account_value":6,"warning_on_anomalous_logins":0},"subusers":{"can_add":1,"can_edit":1,"can_delete":1}}
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=25c3f01d6ac693599cbc03d753826089
result_info_apis_access_to_all_except=
result_info_conversions_can_add=1
result_info_conversions_can_edit=1
result_info_conversions_can_delete=1
result_info_conversions_can_link=1
result_info_conversions_can_unlink=1
result_info_conversions_access_to_all_except=
result_info_ctas_can_add=1
result_info_ctas_can_edit=1
result_info_ctas_can_delete=1
result_info_ctas_can_link=1
result_info_ctas_can_unlink=1
result_info_ctas_access_to_all_except=
result_info_domains_can_add=1
result_info_domains_can_edit=1
result_info_domains_can_delete=1
result_info_domains_access_to_all_except=
result_info_domains_all_except_0_id=609f542eecb0b23d443080952528a3bd
result_info_domains_all_except_0_name=domain_0
result_info_domains_all_except_1_id=d016798d2bf704129ca96df599a4ae76
result_info_domains_all_except_1_name=domain_1
result_info_plans_can_manage_plans=0
result_info_plans_can_manage_billing=0
result_info_projects_can_add=1
result_info_projects_can_edit=1
result_info_projects_can_delete=1
result_info_projects_access_to_default=1
result_info_remarketings_can_add=1
result_info_remarketings_can_edit=1
result_info_remarketings_can_delete=1
result_info_remarketings_can_link=1
result_info_remarketings_can_unlink=1
result_info_remarketings_access_to_all_except=
result_info_security_inactivity_timeout=0
result_info_security_inactivity_timeout_value=15
result_info_security_force_change_password=0
result_info_security_force_change_password_interval=3
result_info_security_do_not_allow_old_passwords=0
result_info_security_do_not_allow_old_passwords_value=4
result_info_security_disable_inactive_account=0
result_info_security_disable_inactive_account_value=6
result_info_security_warning_on_anomalous_logins=0
result_info_subusers_can_add=1
result_info_subusers_can_edit=1
result_info_subusers_can_delete=1

Example 4 (plain)

Request

https://joturl.com/a/i1/permissions/edit?id=25c3f01d6ac693599cbc03d753826089&name=name+of+the+permission&info=%7B%22apis%22%3A%7B%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22conversions%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22can_link%22%3A1,%22can_unlink%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22ctas%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22can_link%22%3A1,%22can_unlink%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22domains%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D,%22all_except%22%3A%5B%22609f542eecb0b23d443080952528a3bd%22,%22d016798d2bf704129ca96df599a4ae76%22%5D%7D,%22plans%22%3A%7B%22can_manage_plans%22%3A0,%22can_manage_billing%22%3A0%7D,%22projects%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22access_to_default%22%3A1%7D,%22remarketings%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1,%22can_link%22%3A1,%22can_unlink%22%3A1,%22access_to%22%3A%7B%22all_except%22%3A%5B%5D%7D%7D,%22security%22%3A%7B%22inactivity_timeout%22%3A0,%22inactivity_timeout_value%22%3A15,%22force_change_password%22%3A0,%22force_change_password_interval%22%3A3,%22do_not_allow_old_passwords%22%3A0,%22do_not_allow_old_passwords_value%22%3A4,%22disable_inactive_account%22%3A0,%22disable_inactive_account_value%22%3A6,%22warning_on_anomalous_logins%22%3A0%7D,%22subusers%22%3A%7B%22can_add%22%3A1,%22can_edit%22%3A1,%22can_delete%22%3A1%7D%7D&format=plain

Query parameters

    id = 25c3f01d6ac693599cbc03d753826089
  name = name of the permission
  info = {"apis":{"access_to":{"all_except":[]}},"conversions":{"can_add":1,"can_edit":1,"can_delete":1,"can_link":1,"can_unlink":1,"access_to":{"all_except":[]}},"ctas":{"can_add":1,"can_edit":1,"can_delete":1,"can_link":1,"can_unlink":1,"access_to":{"all_except":[]}},"domains":{"can_add":1,"can_edit":1,"can_delete":1,"access_to":{"all_except":[]},"all_except":["609f542eecb0b23d443080952528a3bd","d016798d2bf704129ca96df599a4ae76"]},"plans":{"can_manage_plans":0,"can_manage_billing":0},"projects":{"can_add":1,"can_edit":1,"can_delete":1,"access_to_default":1},"remarketings":{"can_add":1,"can_edit":1,"can_delete":1,"can_link":1,"can_unlink":1,"access_to":{"all_except":[]}},"security":{"inactivity_timeout":0,"inactivity_timeout_value":15,"force_change_password":0,"force_change_password_interval":3,"do_not_allow_old_passwords":0,"do_not_allow_old_passwords_value":4,"disable_inactive_account":0,"disable_inactive_account_value":6,"warning_on_anomalous_logins":0},"subusers":{"can_add":1,"can_edit":1,"can_delete":1}}
format = plain

Response

25c3f01d6ac693599cbc03d753826089

1
1
1
1
1

1
1
1
1
1

1
1
1

609f542eecb0b23d443080952528a3bd
domain_0
d016798d2bf704129ca96df599a4ae76
domain_1
0
0
1
1
1
1
1
1
1
1
1

0
15
0
3
0
4
0
6
0
1
1
1
Required parameters
parameterdescription
idIDID of the permission
Optional parameters
parameterdescriptionmax length
infoJSONinformation on access rights, see i1/permissions/property for details
nameSTRINGname of the permission100
notesSTRINGnotes of the permission255
Return values
parameterdescription
idID of the permission
infoinformation on access rights
namename of the permission
notesnotes of the permission

/permissions/info

access: [READ]

This method returns information on a permission.

Example 1 (json)

Request

https://joturl.com/a/i1/permissions/info?id=bd43f46fe0164032c4f737f81b87bfa0

Query parameters

id = bd43f46fe0164032c4f737f81b87bfa0

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": {
      "id": "bd43f46fe0164032c4f737f81b87bfa0",
      "name": "name of the permission",
      "notes": "notes for the permission",
      "info": {
        "apis": {
          "access_to": {
            "all_except": []
          }
        },
        "conversions": {
          "can_add": 1,
          "can_edit": 1,
          "can_delete": 1,
          "can_link": 1,
          "can_unlink": 1,
          "access_to": {
            "all_except": []
          }
        },
        "ctas": {
          "can_add": 1,
          "can_edit": 1,
          "can_delete": 1,
          "can_link": 1,
          "can_unlink": 1,
          "access_to": {
            "all_except": []
          }
        },
        "domains": {
          "can_add": 1,
          "can_edit": 1,
          "can_delete": 1,
          "access_to": {
            "all_except": []
          },
          "all_except": [
            {
              "id": "cdf620f059a7171e8ff1b1a615f20549",
              "name": "domain_0"
            },
            {
              "id": "52da71a9c049207a055c1777b61a3e1e",
              "name": "domain_1"
            },
            {
              "id": "e73ff141ed804a7a1ca91494ed24c042",
              "name": "domain_2"
            },
            {
              "id": "e66cda94cda7d468bf4ce16c3014f8f1",
              "name": "domain_3"
            }
          ]
        },
        "plans": {
          "can_manage_plans": 0,
          "can_manage_billing": 0
        },
        "projects": {
          "can_add": 1,
          "can_edit": 1,
          "can_delete": 1,
          "access_to_default": 1
        },
        "remarketings": {
          "can_add": 1,
          "can_edit": 1,
          "can_delete": 1,
          "can_link": 1,
          "can_unlink": 1,
          "access_to": {
            "all_except": []
          }
        },
        "security": {
          "inactivity_timeout": 0,
          "inactivity_timeout_value": 15,
          "force_change_password": 0,
          "force_change_password_interval": 3,
          "do_not_allow_old_passwords": 0,
          "do_not_allow_old_passwords_value": 4,
          "disable_inactive_account": 0,
          "disable_inactive_account_value": 6,
          "warning_on_anomalous_logins": 0
        },
        "subusers": {
          "can_add": 1,
          "can_edit": 1,
          "can_delete": 1
        }
      }
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/permissions/info?id=bd43f46fe0164032c4f737f81b87bfa0&format=xml

Query parameters

    id = bd43f46fe0164032c4f737f81b87bfa0
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <id>bd43f46fe0164032c4f737f81b87bfa0</id>  
      <name>name of the permission</name>  
      <notes>notes for the permission</notes>  
      <info>
        <apis>
          <access_to>
            <all_except>

            </all_except>  
          </access_to>  
        </apis>  
        <conversions>
          <can_add>1</can_add>  
          <can_edit>1</can_edit>  
          <can_delete>1</can_delete>  
          <can_link>1</can_link>  
          <can_unlink>1</can_unlink>  
          <access_to>
            <all_except>

            </all_except>  
          </access_to>  
        </conversions>  
        <ctas>
          <can_add>1</can_add>  
          <can_edit>1</can_edit>  
          <can_delete>1</can_delete>  
          <can_link>1</can_link>  
          <can_unlink>1</can_unlink>  
          <access_to>
            <all_except>

            </all_except>  
          </access_to>  
        </ctas>  
        <domains>
          <can_add>1</can_add>  
          <can_edit>1</can_edit>  
          <can_delete>1</can_delete>  
          <access_to>
            <all_except>

            </all_except>  
          </access_to>  
          <all_except>
            <i0>
              <id>cdf620f059a7171e8ff1b1a615f20549</id>  
              <name>domain_0</name>  
            </i0>  
            <i1>
              <id>52da71a9c049207a055c1777b61a3e1e</id>  
              <name>domain_1</name>  
            </i1>  
            <i2>
              <id>e73ff141ed804a7a1ca91494ed24c042</id>  
              <name>domain_2</name>  
            </i2>  
            <i3>
              <id>e66cda94cda7d468bf4ce16c3014f8f1</id>  
              <name>domain_3</name>  
            </i3>  
          </all_except>  
        </domains>  
        <plans>
          <can_manage_plans>0</can_manage_plans>  
          <can_manage_billing>0</can_manage_billing>  
        </plans>  
        <projects>
          <can_add>1</can_add>  
          <can_edit>1</can_edit>  
          <can_delete>1</can_delete>  
          <access_to_default>1</access_to_default>  
        </projects>  
        <remarketings>
          <can_add>1</can_add>  
          <can_edit>1</can_edit>  
          <can_delete>1</can_delete>  
          <can_link>1</can_link>  
          <can_unlink>1</can_unlink>  
          <access_to>
            <all_except>

            </all_except>  
          </access_to>  
        </remarketings>  
        <security>
          <inactivity_timeout>0</inactivity_timeout>  
          <inactivity_timeout_value>15</inactivity_timeout_value>  
          <force_change_password>0</force_change_password>  
          <force_change_password_interval>3</force_change_password_interval>  
          <do_not_allow_old_passwords>0</do_not_allow_old_passwords>  
          <do_not_allow_old_passwords_value>4</do_not_allow_old_passwords_value>  
          <disable_inactive_account>0</disable_inactive_account>  
          <disable_inactive_account_value>6</disable_inactive_account_value>  
          <warning_on_anomalous_logins>0</warning_on_anomalous_logins>  
        </security>  
        <subusers>
          <can_add>1</can_add>  
          <can_edit>1</can_edit>  
          <can_delete>1</can_delete>  
        </subusers>  
      </info>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/permissions/info?id=bd43f46fe0164032c4f737f81b87bfa0&format=txt

Query parameters

    id = bd43f46fe0164032c4f737f81b87bfa0
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_id=bd43f46fe0164032c4f737f81b87bfa0
result_data_name=name of the permission
result_data_notes=notes for the permission
result_data_info_apis_access_to_all_except=
result_data_info_conversions_can_add=1
result_data_info_conversions_can_edit=1
result_data_info_conversions_can_delete=1
result_data_info_conversions_can_link=1
result_data_info_conversions_can_unlink=1
result_data_info_conversions_access_to_all_except=
result_data_info_ctas_can_add=1
result_data_info_ctas_can_edit=1
result_data_info_ctas_can_delete=1
result_data_info_ctas_can_link=1
result_data_info_ctas_can_unlink=1
result_data_info_ctas_access_to_all_except=
result_data_info_domains_can_add=1
result_data_info_domains_can_edit=1
result_data_info_domains_can_delete=1
result_data_info_domains_access_to_all_except=
result_data_info_domains_all_except_0_id=cdf620f059a7171e8ff1b1a615f20549
result_data_info_domains_all_except_0_name=domain_0
result_data_info_domains_all_except_1_id=52da71a9c049207a055c1777b61a3e1e
result_data_info_domains_all_except_1_name=domain_1
result_data_info_domains_all_except_2_id=e73ff141ed804a7a1ca91494ed24c042
result_data_info_domains_all_except_2_name=domain_2
result_data_info_domains_all_except_3_id=e66cda94cda7d468bf4ce16c3014f8f1
result_data_info_domains_all_except_3_name=domain_3
result_data_info_plans_can_manage_plans=0
result_data_info_plans_can_manage_billing=0
result_data_info_projects_can_add=1
result_data_info_projects_can_edit=1
result_data_info_projects_can_delete=1
result_data_info_projects_access_to_default=1
result_data_info_remarketings_can_add=1
result_data_info_remarketings_can_edit=1
result_data_info_remarketings_can_delete=1
result_data_info_remarketings_can_link=1
result_data_info_remarketings_can_unlink=1
result_data_info_remarketings_access_to_all_except=
result_data_info_security_inactivity_timeout=0
result_data_info_security_inactivity_timeout_value=15
result_data_info_security_force_change_password=0
result_data_info_security_force_change_password_interval=3
result_data_info_security_do_not_allow_old_passwords=0
result_data_info_security_do_not_allow_old_passwords_value=4
result_data_info_security_disable_inactive_account=0
result_data_info_security_disable_inactive_account_value=6
result_data_info_security_warning_on_anomalous_logins=0
result_data_info_subusers_can_add=1
result_data_info_subusers_can_edit=1
result_data_info_subusers_can_delete=1

Example 4 (plain)

Request

https://joturl.com/a/i1/permissions/info?id=bd43f46fe0164032c4f737f81b87bfa0&format=plain

Query parameters

    id = bd43f46fe0164032c4f737f81b87bfa0
format = plain

Response

bd43f46fe0164032c4f737f81b87bfa0
name of the permission
notes for the permission

1
1
1
1
1

1
1
1
1
1

1
1
1

cdf620f059a7171e8ff1b1a615f20549
domain_0
52da71a9c049207a055c1777b61a3e1e
domain_1
e73ff141ed804a7a1ca91494ed24c042
domain_2
e66cda94cda7d468bf4ce16c3014f8f1
domain_3
0
0
1
1
1
1
1
1
1
1
1

0
15
0
3
0
4
0
6
0
1
1
1
Required parameters
parameterdescription
idIDID of the permission
Return values
parameterdescription
dataarray containing information on the permission, see i1/permissions/list and i1/permissions/property for details

/permissions/list

access: [READ]

This method returns a list of user-defined permissions.

Example 1 (json)

Request

https://joturl.com/a/i1/permissions/list

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 1,
    "data": [
      {
        "id": "dfaed163d3a70d0e1ff3d23abd351317",
        "name": "name of the permission",
        "notes": "notes for the permission"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/permissions/list?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>1</count>  
    <data>
      <i0>
        <id>dfaed163d3a70d0e1ff3d23abd351317</id>  
        <name>name of the permission</name>  
        <notes>notes for the permission</notes>  
      </i0>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/permissions/list?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=1
result_data_0_id=dfaed163d3a70d0e1ff3d23abd351317
result_data_0_name=name of the permission
result_data_0_notes=notes for the permission

Example 4 (plain)

Request

https://joturl.com/a/i1/permissions/list?format=plain

Query parameters

format = plain

Response

1
dfaed163d3a70d0e1ff3d23abd351317
name of the permission
notes for the permission
Optional parameters
parameterdescription
lengthINTEGERextracts this number of items (maxmimum allowed: 100)
orderbyARRAYorders items by field
searchSTRINGfilters items to be extracted by searching them
sortSTRINGsorts items in ascending (ASC) or descending (DESC) order
startINTEGERstarts to extract items from this position
Return values
parameterdescription
counttotal number of permissions
dataarray containing information on permissions

/permissions/property

access: [READ]

This method returns access rights you can use to create a permission. Each access right is grouped by contexts.

Example 1 (json)

Request

https://joturl.com/a/i1/permissions/property

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "apis": {
      "access_to": {
        "type": "complementary_ids",
        "default": {
          "all_except": []
        },
        "available": 1
      }
    },
    "conversions": {
      "can_add": {
        "type": "bool",
        "default": 1,
        "available": 1
      },
      "can_edit": {
        "type": "bool",
        "default": 1,
        "available": 1
      },
      "can_delete": {
        "type": "bool",
        "default": 1,
        "available": 1
      },
      "can_link": {
        "type": "bool",
        "default": 1,
        "available": 1
      },
      "can_unlink": {
        "type": "bool",
        "default": 1,
        "available": 1
      },
      "access_to": {
        "type": "complementary_ids",
        "default": {
          "all_except": []
        },
        "available": 1
      }
    },
    "ctas": {
      "can_add": {
        "type": "bool",
        "default": 1,
        "available": 1
      },
      "can_edit": {
        "type": "bool",
        "default": 1,
        "available": 1
      },
      "can_delete": {
        "type": "bool",
        "default": 1,
        "available": 1
      },
      "can_link": {
        "type": "bool",
        "default": 1,
        "available": 1
      },
      "can_unlink": {
        "type": "bool",
        "default": 1,
        "available": 1
      },
      "access_to": {
        "type": "complementary_ids",
        "default": {
          "all_except": []
        },
        "available": 1
      }
    },
    "domains": {
      "can_add": {
        "type": "bool",
        "default": 1,
        "available": 1
      },
      "can_edit": {
        "type": "bool",
        "default": 1,
        "available": 1
      },
      "can_delete": {
        "type": "bool",
        "default": 1,
        "available": 1
      },
      "access_to": {
        "type": "complementary_ids",
        "default": {
          "all_except": []
        },
        "available": 1
      }
    },
    "plans": {
      "can_manage_plans": {
        "type": "bool",
        "default": 0,
        "available": 1
      },
      "can_manage_billing": {
        "type": "bool",
        "default": 0,
        "available": 1
      }
    },
    "projects": {
      "can_add": {
        "type": "bool",
        "default": 1,
        "available": 1
      },
      "can_edit": {
        "type": "bool",
        "default": 1,
        "available": 1
      },
      "can_delete": {
        "type": "bool",
        "default": 1,
        "available": 1
      },
      "access_to_default": {
        "type": "bool",
        "default": 1,
        "available": 1
      }
    },
    "remarketings": {
      "can_add": {
        "type": "bool",
        "default": 1,
        "available": 1
      },
      "can_edit": {
        "type": "bool",
        "default": 1,
        "available": 1
      },
      "can_delete": {
        "type": "bool",
        "default": 1,
        "available": 1
      },
      "can_link": {
        "type": "bool",
        "default": 1,
        "available": 1
      },
      "can_unlink": {
        "type": "bool",
        "default": 1,
        "available": 1
      },
      "access_to": {
        "type": "complementary_ids",
        "default": {
          "all_except": []
        },
        "available": 1
      }
    },
    "security": {
      "inactivity_timeout": {
        "ref_value": "inactivity_timeout_value",
        "type": "bool_with_value",
        "default": 0,
        "available": 1
      },
      "inactivity_timeout_value": {
        "type": "int",
        "default": 15,
        "min": 15,
        "max": 43200,
        "available": 1
      },
      "force_change_password": {
        "ref_value": "force_change_password_interval",
        "type": "bool_with_value",
        "default": 0,
        "available": 1
      },
      "force_change_password_interval": {
        "type": "int",
        "default": 3,
        "min": 2,
        "max": 60,
        "available": 1
      },
      "do_not_allow_old_passwords": {
        "ref_value": "do_not_allow_old_passwords_value",
        "type": "bool_with_value",
        "default": 0,
        "available": 1
      },
      "do_not_allow_old_passwords_value": {
        "type": "int",
        "default": 4,
        "min": 2,
        "max": 10,
        "available": 1
      },
      "disable_inactive_account": {
        "ref_value": "disable_inactive_account_value",
        "type": "bool_with_value",
        "default": 0,
        "available": 1
      },
      "disable_inactive_account_value": {
        "type": "int",
        "default": 6,
        "min": 2,
        "max": 36,
        "available": 1
      },
      "warning_on_anomalous_logins": {
        "type": "bool",
        "default": 0,
        "available": 1
      }
    },
    "subusers": {
      "can_add": {
        "type": "bool",
        "default": 1,
        "available": 1
      },
      "can_edit": {
        "type": "bool",
        "default": 1,
        "available": 1
      },
      "can_delete": {
        "type": "bool",
        "default": 1,
        "available": 1
      }
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/permissions/property?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <apis>
      <access_to>
        <type>complementary_ids</type>  
        <default>
          <all_except>

          </all_except>  
        </default>  
        <available>1</available>  
      </access_to>  
    </apis>  
    <conversions>
      <can_add>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </can_add>  
      <can_edit>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </can_edit>  
      <can_delete>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </can_delete>  
      <can_link>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </can_link>  
      <can_unlink>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </can_unlink>  
      <access_to>
        <type>complementary_ids</type>  
        <default>
          <all_except>

          </all_except>  
        </default>  
        <available>1</available>  
      </access_to>  
    </conversions>  
    <ctas>
      <can_add>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </can_add>  
      <can_edit>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </can_edit>  
      <can_delete>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </can_delete>  
      <can_link>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </can_link>  
      <can_unlink>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </can_unlink>  
      <access_to>
        <type>complementary_ids</type>  
        <default>
          <all_except>

          </all_except>  
        </default>  
        <available>1</available>  
      </access_to>  
    </ctas>  
    <domains>
      <can_add>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </can_add>  
      <can_edit>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </can_edit>  
      <can_delete>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </can_delete>  
      <access_to>
        <type>complementary_ids</type>  
        <default>
          <all_except>

          </all_except>  
        </default>  
        <available>1</available>  
      </access_to>  
    </domains>  
    <plans>
      <can_manage_plans>
        <type>bool</type>  
        <default>0</default>  
        <available>1</available>  
      </can_manage_plans>  
      <can_manage_billing>
        <type>bool</type>  
        <default>0</default>  
        <available>1</available>  
      </can_manage_billing>  
    </plans>  
    <projects>
      <can_add>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </can_add>  
      <can_edit>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </can_edit>  
      <can_delete>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </can_delete>  
      <access_to_default>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </access_to_default>  
    </projects>  
    <remarketings>
      <can_add>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </can_add>  
      <can_edit>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </can_edit>  
      <can_delete>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </can_delete>  
      <can_link>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </can_link>  
      <can_unlink>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </can_unlink>  
      <access_to>
        <type>complementary_ids</type>  
        <default>
          <all_except>

          </all_except>  
        </default>  
        <available>1</available>  
      </access_to>  
    </remarketings>  
    <security>
      <inactivity_timeout>
        <ref_value>inactivity_timeout_value</ref_value>  
        <type>bool_with_value</type>  
        <default>0</default>  
        <available>1</available>  
      </inactivity_timeout>  
      <inactivity_timeout_value>
        <type>int</type>  
        <default>15</default>  
        <min>15</min>  
        <max>43200</max>  
        <available>1</available>  
      </inactivity_timeout_value>  
      <force_change_password>
        <ref_value>force_change_password_interval</ref_value>  
        <type>bool_with_value</type>  
        <default>0</default>  
        <available>1</available>  
      </force_change_password>  
      <force_change_password_interval>
        <type>int</type>  
        <default>3</default>  
        <min>2</min>  
        <max>60</max>  
        <available>1</available>  
      </force_change_password_interval>  
      <do_not_allow_old_passwords>
        <ref_value>do_not_allow_old_passwords_value</ref_value>  
        <type>bool_with_value</type>  
        <default>0</default>  
        <available>1</available>  
      </do_not_allow_old_passwords>  
      <do_not_allow_old_passwords_value>
        <type>int</type>  
        <default>4</default>  
        <min>2</min>  
        <max>10</max>  
        <available>1</available>  
      </do_not_allow_old_passwords_value>  
      <disable_inactive_account>
        <ref_value>disable_inactive_account_value</ref_value>  
        <type>bool_with_value</type>  
        <default>0</default>  
        <available>1</available>  
      </disable_inactive_account>  
      <disable_inactive_account_value>
        <type>int</type>  
        <default>6</default>  
        <min>2</min>  
        <max>36</max>  
        <available>1</available>  
      </disable_inactive_account_value>  
      <warning_on_anomalous_logins>
        <type>bool</type>  
        <default>0</default>  
        <available>1</available>  
      </warning_on_anomalous_logins>  
    </security>  
    <subusers>
      <can_add>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </can_add>  
      <can_edit>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </can_edit>  
      <can_delete>
        <type>bool</type>  
        <default>1</default>  
        <available>1</available>  
      </can_delete>  
    </subusers>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/permissions/property?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_apis_access_to_type=complementary_ids
result_apis_access_to_default_all_except=
result_apis_access_to_available=1
result_conversions_can_add_type=bool
result_conversions_can_add_default=1
result_conversions_can_add_available=1
result_conversions_can_edit_type=bool
result_conversions_can_edit_default=1
result_conversions_can_edit_available=1
result_conversions_can_delete_type=bool
result_conversions_can_delete_default=1
result_conversions_can_delete_available=1
result_conversions_can_link_type=bool
result_conversions_can_link_default=1
result_conversions_can_link_available=1
result_conversions_can_unlink_type=bool
result_conversions_can_unlink_default=1
result_conversions_can_unlink_available=1
result_conversions_access_to_type=complementary_ids
result_conversions_access_to_default_all_except=
result_conversions_access_to_available=1
result_ctas_can_add_type=bool
result_ctas_can_add_default=1
result_ctas_can_add_available=1
result_ctas_can_edit_type=bool
result_ctas_can_edit_default=1
result_ctas_can_edit_available=1
result_ctas_can_delete_type=bool
result_ctas_can_delete_default=1
result_ctas_can_delete_available=1
result_ctas_can_link_type=bool
result_ctas_can_link_default=1
result_ctas_can_link_available=1
result_ctas_can_unlink_type=bool
result_ctas_can_unlink_default=1
result_ctas_can_unlink_available=1
result_ctas_access_to_type=complementary_ids
result_ctas_access_to_default_all_except=
result_ctas_access_to_available=1
result_domains_can_add_type=bool
result_domains_can_add_default=1
result_domains_can_add_available=1
result_domains_can_edit_type=bool
result_domains_can_edit_default=1
result_domains_can_edit_available=1
result_domains_can_delete_type=bool
result_domains_can_delete_default=1
result_domains_can_delete_available=1
result_domains_access_to_type=complementary_ids
result_domains_access_to_default_all_except=
result_domains_access_to_available=1
result_plans_can_manage_plans_type=bool
result_plans_can_manage_plans_default=0
result_plans_can_manage_plans_available=1
result_plans_can_manage_billing_type=bool
result_plans_can_manage_billing_default=0
result_plans_can_manage_billing_available=1
result_projects_can_add_type=bool
result_projects_can_add_default=1
result_projects_can_add_available=1
result_projects_can_edit_type=bool
result_projects_can_edit_default=1
result_projects_can_edit_available=1
result_projects_can_delete_type=bool
result_projects_can_delete_default=1
result_projects_can_delete_available=1
result_projects_access_to_default_type=bool
result_projects_access_to_default_default=1
result_projects_access_to_default_available=1
result_remarketings_can_add_type=bool
result_remarketings_can_add_default=1
result_remarketings_can_add_available=1
result_remarketings_can_edit_type=bool
result_remarketings_can_edit_default=1
result_remarketings_can_edit_available=1
result_remarketings_can_delete_type=bool
result_remarketings_can_delete_default=1
result_remarketings_can_delete_available=1
result_remarketings_can_link_type=bool
result_remarketings_can_link_default=1
result_remarketings_can_link_available=1
result_remarketings_can_unlink_type=bool
result_remarketings_can_unlink_default=1
result_remarketings_can_unlink_available=1
result_remarketings_access_to_type=complementary_ids
result_remarketings_access_to_default_all_except=
result_remarketings_access_to_available=1
result_security_inactivity_timeout_ref_value=inactivity_timeout_value
result_security_inactivity_timeout_type=bool_with_value
result_security_inactivity_timeout_default=0
result_security_inactivity_timeout_available=1
result_security_inactivity_timeout_value_type=int
result_security_inactivity_timeout_value_default=15
result_security_inactivity_timeout_value_min=15
result_security_inactivity_timeout_value_max=43200
result_security_inactivity_timeout_value_available=1
result_security_force_change_password_ref_value=force_change_password_interval
result_security_force_change_password_type=bool_with_value
result_security_force_change_password_default=0
result_security_force_change_password_available=1
result_security_force_change_password_interval_type=int
result_security_force_change_password_interval_default=3
result_security_force_change_password_interval_min=2
result_security_force_change_password_interval_max=60
result_security_force_change_password_interval_available=1
result_security_do_not_allow_old_passwords_ref_value=do_not_allow_old_passwords_value
result_security_do_not_allow_old_passwords_type=bool_with_value
result_security_do_not_allow_old_passwords_default=0
result_security_do_not_allow_old_passwords_available=1
result_security_do_not_allow_old_passwords_value_type=int
result_security_do_not_allow_old_passwords_value_default=4
result_security_do_not_allow_old_passwords_value_min=2
result_security_do_not_allow_old_passwords_value_max=10
result_security_do_not_allow_old_passwords_value_available=1
result_security_disable_inactive_account_ref_value=disable_inactive_account_value
result_security_disable_inactive_account_type=bool_with_value
result_security_disable_inactive_account_default=0
result_security_disable_inactive_account_available=1
result_security_disable_inactive_account_value_type=int
result_security_disable_inactive_account_value_default=6
result_security_disable_inactive_account_value_min=2
result_security_disable_inactive_account_value_max=36
result_security_disable_inactive_account_value_available=1
result_security_warning_on_anomalous_logins_type=bool
result_security_warning_on_anomalous_logins_default=0
result_security_warning_on_anomalous_logins_available=1
result_subusers_can_add_type=bool
result_subusers_can_add_default=1
result_subusers_can_add_available=1
result_subusers_can_edit_type=bool
result_subusers_can_edit_default=1
result_subusers_can_edit_available=1
result_subusers_can_delete_type=bool
result_subusers_can_delete_default=1
result_subusers_can_delete_available=1

Example 4 (plain)

Request

https://joturl.com/a/i1/permissions/property?format=plain

Query parameters

format = plain

Response

complementary_ids

1
bool
default:1
1
bool
default:1
1
bool
default:1
1
bool
default:1
1
bool
default:1
1
complementary_ids

1
bool
default:1
1
bool
default:1
1
bool
default:1
1
bool
default:1
1
bool
default:1
1
complementary_ids

1
bool
default:1
1
bool
default:1
1
bool
default:1
1
complementary_ids

1
bool
default:0
1
bool
default:0
1
bool
default:1
1
bool
default:1
1
bool
default:1
1
bool
default:1
1
bool
default:1
1
bool
default:1
1
bool
default:1
1
bool
default:1
1
bool
default:1
1
complementary_ids

1
inactivity_timeout_value
bool_with_value
default:0
1
int
default:15
15
43200
1
force_change_password_interval
bool_with_value
default:0
1
int
default:3
2
60
1
do_not_allow_old_passwords_value
bool_with_value
default:0
1
int
default:4
2
10
1
disable_inactive_account_value
bool_with_value
default:0
1
int
default:6
2
36
1
bool
default:0
1
bool
default:1
1
bool
default:1
1
bool
default:1
1
Return values
parameterdescription
dataobject containing available access permissions and their descriptions

/plans

/plans/addresses

/plans/addresses/add

access: [WRITE]

This method adds address information about the user.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/addresses/add?is_business=1&name=John+Smith&address=72+Sussex+St.&postal_code=21122&city=Pasadena&country_code=US&responsibility_check=2025-06-27+16%3A53%3A14

Query parameters

         is_business = 1
                name = John Smith
             address = 72 Sussex St.
         postal_code = 21122
                city = Pasadena
        country_code = US
responsibility_check = 2025-06-27 16:53:14

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "added": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/addresses/add?is_business=1&name=John+Smith&address=72+Sussex+St.&postal_code=21122&city=Pasadena&country_code=US&responsibility_check=2025-06-27+16%3A53%3A14&format=xml

Query parameters

         is_business = 1
                name = John Smith
             address = 72 Sussex St.
         postal_code = 21122
                city = Pasadena
        country_code = US
responsibility_check = 2025-06-27 16:53:14
              format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <added>1</added>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/addresses/add?is_business=1&name=John+Smith&address=72+Sussex+St.&postal_code=21122&city=Pasadena&country_code=US&responsibility_check=2025-06-27+16%3A53%3A14&format=txt

Query parameters

         is_business = 1
                name = John Smith
             address = 72 Sussex St.
         postal_code = 21122
                city = Pasadena
        country_code = US
responsibility_check = 2025-06-27 16:53:14
              format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_added=1

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/addresses/add?is_business=1&name=John+Smith&address=72+Sussex+St.&postal_code=21122&city=Pasadena&country_code=US&responsibility_check=2025-06-27+16%3A53%3A14&format=plain

Query parameters

         is_business = 1
                name = John Smith
             address = 72 Sussex St.
         postal_code = 21122
                city = Pasadena
        country_code = US
responsibility_check = 2025-06-27 16:53:14
              format = plain

Response

1
Required parameters
parameterdescriptionmax length
addressSTRINGbilling address255
citySTRINGbilling city255
country_codeSTRINGbilling country code2
is_businessBOOLEAN1 for business accounts, 0 for private
nameSTRINGbilling name255
postal_codeSTRINGbilling postal code50
responsibility_checkDATE_TIMEdate/time (UTC) in which the declaration of correctness of the address information was signed, the value passed is mandatory and must be a valid date/time, but it is always overwritten with the date/time of the call to this endpoint
Optional parameters
parameterdescriptionmax length
cfSTRINGfiscal code for private Italian users16
pecSTRINGcertified email address for Italian users255
provinceSTRINGprovince for Italian users, see i1/provinces/list for details2
recipient_codeSTRINGrecipient code for Italian users15
vat_idSTRINGVAT ID for business users50
Return values
parameterdescription
added1 on success, 0 otherwise

/plans/addresses/info

access: [READ]

This method returns address information about the user.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/addresses/info

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "is_business": 1,
    "name": "John Smith",
    "address": "72 Sussex St.",
    "postal_code": "21122",
    "city": "Pasadena",
    "country_code": "US",
    "vat_treatment": "EXTRA_EU_BUSINESS",
    "vat_id": "",
    "cf": "",
    "pec": "",
    "recipient_code": "",
    "province": "",
    "responsibility_check": "2025-06-27 16:53:14"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/addresses/info?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <is_business>1</is_business>  
    <name>John Smith</name>  
    <address>72 Sussex St.</address>  
    <postal_code>21122</postal_code>  
    <city>Pasadena</city>  
    <country_code>US</country_code>  
    <vat_treatment>EXTRA_EU_BUSINESS</vat_treatment>  
    <vat_id></vat_id>  
    <cf></cf>  
    <pec></pec>  
    <recipient_code></recipient_code>  
    <province></province>  
    <responsibility_check>2025-06-27 16:53:14</responsibility_check>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/addresses/info?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_is_business=1
result_name=John Smith
result_address=72 Sussex St.
result_postal_code=21122
result_city=Pasadena
result_country_code=US
result_vat_treatment=EXTRA_EU_BUSINESS
result_vat_id=
result_cf=
result_pec=
result_recipient_code=
result_province=
result_responsibility_check=2025-06-27 16:53:14

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/addresses/info?format=plain

Query parameters

format = plain

Response

1
John Smith
72 Sussex St.
21122
Pasadena
US
EXTRA_EU_BUSINESS





2025-06-27 16:53:14
Return values
parameterdescription
addressbilling address
cffiscal code for private Italian users
citybilling city
country_codebilling country code
is_business1 for business accounts, 0 for private
namebilling name
peccertified email address for private Italian users
postal_codebilling postal code
provinceprovince for private Italian users
recipient_coderecipient code for private Italian users
responsibility_checkdate/time (UTC) when the declaration of correctness of the address information was signed
vat_idVAT ID for business users
vat_treatmentNA

/plans/addresses/locations

/plans/addresses/locations/list

access: [READ]

This method returns a list of available countries/localities for the user's billing addresses.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/addresses/locations/list

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "locations": [
      {
        "label": "Afghanistan (\u0627\u0641\u063a\u0627\u0646\u0633\u062a\u0627\u0646)",
        "code": "AF",
        "other": 0
      },
      {
        "label": "Aland Islands",
        "code": "AX",
        "other": 0
      },
      {
        "label": "Albania (Shqipëria)",
        "code": "AL",
        "other": 0
      },
      {
        "label": "Algeria (\u0627\u0644\u062c\u0632\u0627\u0626\u0631)",
        "code": "DZ",
        "other": 0
      },
      {
        "label": "American Samoa",
        "code": "AS",
        "other": 0
      },
      {
        "label": "Andorra",
        "code": "AD",
        "other": 0
      },
      {
        "label": "Angola",
        "code": "AO",
        "other": 0
      },
      {
        "label": "Anguilla",
        "code": "AI",
        "other": 0
      },
      {
        "label": "Antarctica",
        "code": "AQ",
        "other": 0
      },
      {
        "label": "Antigua and Barbuda",
        "code": "AG",
        "other": 0
      },
      {
        "label": "Argentina",
        "code": "AR",
        "other": 0
      },
      {
        "label": "Armenia (\u0540\u0561\u0575\u0561\u057d\u057f\u0561\u0576)",
        "code": "AM",
        "other": 0
      },
      {
        "label": "Aruba",
        "code": "AW",
        "other": 0
      },
      {
        "label": "Australia",
        "code": "AU",
        "other": 0
      },
      {
        "label": "Austria (Österreich)",
        "code": "AT",
        "other": 0
      },
      {
        "label": "Azerbaijan (Az\u0259rbaycan)",
        "code": "AZ",
        "other": 0
      },
      {
        "label": "[....]",
        "code": "..",
        "other": 0
      },
      {
        "label": "Canary Islands",
        "code": "_C",
        "other": 1
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/addresses/locations/list?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <locations>
      <i0>
        <label>Afghanistan (افغانستان)</label>  
        <code>AF</code>  
        <other>0</other>  
      </i0>  
      <i1>
        <label>Aland Islands</label>  
        <code>AX</code>  
        <other>0</other>  
      </i1>  
      <i2>
        <label><[CDATA[Albania (Shqip&euml;ria)]]></label>  
        <code>AL</code>  
        <other>0</other>  
      </i2>  
      <i3>
        <label>Algeria (الجزائر)</label>  
        <code>DZ</code>  
        <other>0</other>  
      </i3>  
      <i4>
        <label>American Samoa</label>  
        <code>AS</code>  
        <other>0</other>  
      </i4>  
      <i5>
        <label>Andorra</label>  
        <code>AD</code>  
        <other>0</other>  
      </i5>  
      <i6>
        <label>Angola</label>  
        <code>AO</code>  
        <other>0</other>  
      </i6>  
      <i7>
        <label>Anguilla</label>  
        <code>AI</code>  
        <other>0</other>  
      </i7>  
      <i8>
        <label>Antarctica</label>  
        <code>AQ</code>  
        <other>0</other>  
      </i8>  
      <i9>
        <label>Antigua and Barbuda</label>  
        <code>AG</code>  
        <other>0</other>  
      </i9>  
      <i10>
        <label>Argentina</label>  
        <code>AR</code>  
        <other>0</other>  
      </i10>  
      <i11>
        <label>Armenia (Հայաստան)</label>  
        <code>AM</code>  
        <other>0</other>  
      </i11>  
      <i12>
        <label>Aruba</label>  
        <code>AW</code>  
        <other>0</other>  
      </i12>  
      <i13>
        <label>Australia</label>  
        <code>AU</code>  
        <other>0</other>  
      </i13>  
      <i14>
        <label><[CDATA[Austria (&Ouml;sterreich)]]></label>  
        <code>AT</code>  
        <other>0</other>  
      </i14>  
      <i15>
        <label>Azerbaijan (Azərbaycan)</label>  
        <code>AZ</code>  
        <other>0</other>  
      </i15>  
      <i16>
        <label>[....]</label>  
        <code>..</code>  
        <other>0</other>  
      </i16>  
      <i17>
        <label>Canary Islands</label>  
        <code>_C</code>  
        <other>1</other>  
      </i17>  
    </locations>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/addresses/locations/list?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_locations_0_label=Afghanistan (افغانستان)
result_locations_0_code=AF
result_locations_0_other=0
result_locations_1_label=Aland Islands
result_locations_1_code=AX
result_locations_1_other=0
result_locations_2_label=Albania (Shqip&euml;ria)
result_locations_2_code=AL
result_locations_2_other=0
result_locations_3_label=Algeria (الجزائر)
result_locations_3_code=DZ
result_locations_3_other=0
result_locations_4_label=American Samoa
result_locations_4_code=AS
result_locations_4_other=0
result_locations_5_label=Andorra
result_locations_5_code=AD
result_locations_5_other=0
result_locations_6_label=Angola
result_locations_6_code=AO
result_locations_6_other=0
result_locations_7_label=Anguilla
result_locations_7_code=AI
result_locations_7_other=0
result_locations_8_label=Antarctica
result_locations_8_code=AQ
result_locations_8_other=0
result_locations_9_label=Antigua and Barbuda
result_locations_9_code=AG
result_locations_9_other=0
result_locations_10_label=Argentina
result_locations_10_code=AR
result_locations_10_other=0
result_locations_11_label=Armenia (Հայաստան)
result_locations_11_code=AM
result_locations_11_other=0
result_locations_12_label=Aruba
result_locations_12_code=AW
result_locations_12_other=0
result_locations_13_label=Australia
result_locations_13_code=AU
result_locations_13_other=0
result_locations_14_label=Austria (&Ouml;sterreich)
result_locations_14_code=AT
result_locations_14_other=0
result_locations_15_label=Azerbaijan (Azərbaycan)
result_locations_15_code=AZ
result_locations_15_other=0
result_locations_16_label=[....]
result_locations_16_code=..
result_locations_16_other=0
result_locations_17_label=Canary Islands
result_locations_17_code=_C
result_locations_17_other=1

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/addresses/locations/list?format=plain

Query parameters

format = plain

Response

Afghanistan (افغانستان)
AF
0
Aland Islands
AX
0
Albania (Shqip&euml;ria)
AL
0
Algeria (الجزائر)
DZ
0
American Samoa
AS
0
Andorra
AD
0
Angola
AO
0
Anguilla
AI
0
Antarctica
AQ
0
Antigua and Barbuda
AG
0
Argentina
AR
0
Armenia (Հայաստան)
AM
0
Aruba
AW
0
Australia
AU
0
Austria (&Ouml;sterreich)
AT
0
Azerbaijan (Azərbaycan)
AZ
0
[....]
..
0
Canary Islands
_C
1
Return values
parameterdescription
locationslist of available countries/locations

/plans/addresses/property

access: [READ]

This method returns requirements for the user info.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/addresses/property?is_business=0&country_code=US

Query parameters

 is_business = 0
country_code = US

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "vat_treatment": "EXTRA_EU_PRIVATE",
    "vat_id": {
      "mandatory": 0,
      "show": 0
    },
    "cf": {
      "mandatory": 0,
      "show": 0
    },
    "pec": {
      "mandatory": 0,
      "show": 0
    },
    "recipient_code": {
      "mandatory": 0,
      "show": 0
    },
    "province": {
      "mandatory": 0,
      "show": 0
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/addresses/property?is_business=0&country_code=US&format=xml

Query parameters

 is_business = 0
country_code = US
      format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <vat_treatment>EXTRA_EU_PRIVATE</vat_treatment>  
    <vat_id>
      <mandatory>0</mandatory>  
      <show>0</show>  
    </vat_id>  
    <cf>
      <mandatory>0</mandatory>  
      <show>0</show>  
    </cf>  
    <pec>
      <mandatory>0</mandatory>  
      <show>0</show>  
    </pec>  
    <recipient_code>
      <mandatory>0</mandatory>  
      <show>0</show>  
    </recipient_code>  
    <province>
      <mandatory>0</mandatory>  
      <show>0</show>  
    </province>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/addresses/property?is_business=0&country_code=US&format=txt

Query parameters

 is_business = 0
country_code = US
      format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_vat_treatment=EXTRA_EU_PRIVATE
result_vat_id_mandatory=0
result_vat_id_show=0
result_cf_mandatory=0
result_cf_show=0
result_pec_mandatory=0
result_pec_show=0
result_recipient_code_mandatory=0
result_recipient_code_show=0
result_province_mandatory=0
result_province_show=0

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/addresses/property?is_business=0&country_code=US&format=plain

Query parameters

 is_business = 0
country_code = US
      format = plain

Response

EXTRA_EU_PRIVATE
0
0
0
0
0
0
0
0
0
0

Example 5 (json)

Request

https://joturl.com/a/i1/plans/addresses/property?is_business=1&country_code=US

Query parameters

 is_business = 1
country_code = US

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "vat_treatment": "EXTRA_EU_BUSINESS",
    "vat_id": {
      "mandatory": 0,
      "show": 1
    },
    "cf": {
      "mandatory": 0,
      "show": 0
    },
    "pec": {
      "mandatory": 1,
      "show": 0
    },
    "recipient_code": {
      "mandatory": 1,
      "show": 0
    },
    "province": {
      "mandatory": 0,
      "show": 0
    }
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/plans/addresses/property?is_business=1&country_code=US&format=xml

Query parameters

 is_business = 1
country_code = US
      format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <vat_treatment>EXTRA_EU_BUSINESS</vat_treatment>  
    <vat_id>
      <mandatory>0</mandatory>  
      <show>1</show>  
    </vat_id>  
    <cf>
      <mandatory>0</mandatory>  
      <show>0</show>  
    </cf>  
    <pec>
      <mandatory>1</mandatory>  
      <show>0</show>  
    </pec>  
    <recipient_code>
      <mandatory>1</mandatory>  
      <show>0</show>  
    </recipient_code>  
    <province>
      <mandatory>0</mandatory>  
      <show>0</show>  
    </province>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/plans/addresses/property?is_business=1&country_code=US&format=txt

Query parameters

 is_business = 1
country_code = US
      format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_vat_treatment=EXTRA_EU_BUSINESS
result_vat_id_mandatory=0
result_vat_id_show=1
result_cf_mandatory=0
result_cf_show=0
result_pec_mandatory=1
result_pec_show=0
result_recipient_code_mandatory=1
result_recipient_code_show=0
result_province_mandatory=0
result_province_show=0

Example 8 (plain)

Request

https://joturl.com/a/i1/plans/addresses/property?is_business=1&country_code=US&format=plain

Query parameters

 is_business = 1
country_code = US
      format = plain

Response

EXTRA_EU_BUSINESS
0
1
0
0
1
0
1
0
0
0

Example 9 (json)

Request

https://joturl.com/a/i1/plans/addresses/property?is_business=0&country_code=IT

Query parameters

 is_business = 0
country_code = IT

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "vat_treatment": "ITALY_PRIVATE",
    "vat_id": {
      "mandatory": 0,
      "show": 0
    },
    "cf": {
      "mandatory": 1,
      "show": 1
    },
    "pec": {
      "mandatory": 0,
      "show": 1
    },
    "recipient_code": {
      "mandatory": 0,
      "show": 0
    },
    "province": {
      "mandatory": 1,
      "show": 1
    }
  }
}

Example 10 (xml)

Request

https://joturl.com/a/i1/plans/addresses/property?is_business=0&country_code=IT&format=xml

Query parameters

 is_business = 0
country_code = IT
      format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <vat_treatment>ITALY_PRIVATE</vat_treatment>  
    <vat_id>
      <mandatory>0</mandatory>  
      <show>0</show>  
    </vat_id>  
    <cf>
      <mandatory>1</mandatory>  
      <show>1</show>  
    </cf>  
    <pec>
      <mandatory>0</mandatory>  
      <show>1</show>  
    </pec>  
    <recipient_code>
      <mandatory>0</mandatory>  
      <show>0</show>  
    </recipient_code>  
    <province>
      <mandatory>1</mandatory>  
      <show>1</show>  
    </province>  
  </result>  
</response>

Example 11 (txt)

Request

https://joturl.com/a/i1/plans/addresses/property?is_business=0&country_code=IT&format=txt

Query parameters

 is_business = 0
country_code = IT
      format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_vat_treatment=ITALY_PRIVATE
result_vat_id_mandatory=0
result_vat_id_show=0
result_cf_mandatory=1
result_cf_show=1
result_pec_mandatory=0
result_pec_show=1
result_recipient_code_mandatory=0
result_recipient_code_show=0
result_province_mandatory=1
result_province_show=1

Example 12 (plain)

Request

https://joturl.com/a/i1/plans/addresses/property?is_business=0&country_code=IT&format=plain

Query parameters

 is_business = 0
country_code = IT
      format = plain

Response

ITALY_PRIVATE
0
0
1
1
0
1
0
0
1
1

Example 13 (json)

Request

https://joturl.com/a/i1/plans/addresses/property?is_business=1&country_code=IT

Query parameters

 is_business = 1
country_code = IT

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "vat_treatment": "ITALY_BUSINESS",
    "vat_id": {
      "mandatory": 1,
      "show": 1
    },
    "cf": {
      "mandatory": 0,
      "show": 0
    },
    "pec": {
      "mandatory": 1,
      "show": 1
    },
    "recipient_code": {
      "mandatory": 1,
      "show": 1
    },
    "province": {
      "mandatory": 1,
      "show": 1
    }
  }
}

Example 14 (xml)

Request

https://joturl.com/a/i1/plans/addresses/property?is_business=1&country_code=IT&format=xml

Query parameters

 is_business = 1
country_code = IT
      format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <vat_treatment>ITALY_BUSINESS</vat_treatment>  
    <vat_id>
      <mandatory>1</mandatory>  
      <show>1</show>  
    </vat_id>  
    <cf>
      <mandatory>0</mandatory>  
      <show>0</show>  
    </cf>  
    <pec>
      <mandatory>1</mandatory>  
      <show>1</show>  
    </pec>  
    <recipient_code>
      <mandatory>1</mandatory>  
      <show>1</show>  
    </recipient_code>  
    <province>
      <mandatory>1</mandatory>  
      <show>1</show>  
    </province>  
  </result>  
</response>

Example 15 (txt)

Request

https://joturl.com/a/i1/plans/addresses/property?is_business=1&country_code=IT&format=txt

Query parameters

 is_business = 1
country_code = IT
      format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_vat_treatment=ITALY_BUSINESS
result_vat_id_mandatory=1
result_vat_id_show=1
result_cf_mandatory=0
result_cf_show=0
result_pec_mandatory=1
result_pec_show=1
result_recipient_code_mandatory=1
result_recipient_code_show=1
result_province_mandatory=1
result_province_show=1

Example 16 (plain)

Request

https://joturl.com/a/i1/plans/addresses/property?is_business=1&country_code=IT&format=plain

Query parameters

 is_business = 1
country_code = IT
      format = plain

Response

ITALY_BUSINESS
1
1
0
0
1
1
1
1
1
1
Required parameters
parameterdescriptionmax length
country_codeSTRINGcode of the country of the user2
is_businessBOOLEAN1 for business users, 0 from private
Return values
parameterdescription
cfarray containing mandatory and show
pecarray containing mandatory and show
provincearray containing mandatory and show
recipient_codearray containing mandatory and show
vat_idarray containing mandatory and show
vat_treatmentVAT threatment type, see i1/plans/vats/property for details

/plans/coupons

/plans/coupons/attach

access: [READ]

This method allows to attach a coupon to the current customer.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/coupons/attach?coupon=45eaf317f54efd3475eda01b5a19f74c

Query parameters

coupon = 45eaf317f54efd3475eda01b5a19f74c

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "attached": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/coupons/attach?coupon=45eaf317f54efd3475eda01b5a19f74c&format=xml

Query parameters

coupon = 45eaf317f54efd3475eda01b5a19f74c
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <attached>1</attached>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/coupons/attach?coupon=45eaf317f54efd3475eda01b5a19f74c&format=txt

Query parameters

coupon = 45eaf317f54efd3475eda01b5a19f74c
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_attached=1

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/coupons/attach?coupon=45eaf317f54efd3475eda01b5a19f74c&format=plain

Query parameters

coupon = 45eaf317f54efd3475eda01b5a19f74c
format = plain

Response

1
Required parameters
parameterdescription
couponSTRINGThe coupon code to be attached
Optional parameters
parameterdescription
detach_existingBOOLEAN1 to detach any coupons already present (default: 0)
Return values
parameterdescription
attached1 on success, an error is emitted otherwise

/plans/coupons/check

access: [READ]

This method checks the validity of a coupon.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/coupons/check?coupon=4de33f36c8418be3589c85285eccc6b2&amount=100

Query parameters

coupon = 4de33f36c8418be3589c85285eccc6b2
amount = 100

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "valid": 1,
    "description": "Test coupon for PayPal",
    "params": {
      "expiration": "2025-12-31T13:13:00+01:00",
      "en": "Test coupon for PayPal",
      "it": "Coupon di prova per PayPal",
      "plan": "pro, business",
      "charge_amount": "12",
      "public_plan": "Pro, Business"
    },
    "amount": 100,
    "amount1": 0,
    "discounted": 0,
    "discounted1": 0,
    "is_100p_discount": 1,
    "charge_amount": 12,
    "charge_amount_formatted": "12.00 €",
    "paypal": {
      "env": "production",
      "client": {
        "production": "4febe4d22560b09c50e22a5fc922761e-311ab18987a46700dfd7072304d040b5"
      }
    },
    "discounted_formatted": "0.00",
    "discounted1_formatted": "0.00"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/coupons/check?coupon=4de33f36c8418be3589c85285eccc6b2&amount=100&format=xml

Query parameters

coupon = 4de33f36c8418be3589c85285eccc6b2
amount = 100
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <valid>1</valid>  
    <description>Test coupon for PayPal</description>  
    <params>
      <expiration>2025-12-31T13:13:00+01:00</expiration>  
      <en>Test coupon for PayPal</en>  
      <it>Coupon di prova per PayPal</it>  
      <plan>pro, business</plan>  
      <charge_amount>12</charge_amount>  
      <public_plan>Pro, Business</public_plan>  
    </params>  
    <amount>100</amount>  
    <amount1>0</amount1>  
    <discounted>0</discounted>  
    <discounted1>0</discounted1>  
    <is_100p_discount>1</is_100p_discount>  
    <charge_amount>12</charge_amount>  
    <charge_amount_formatted><[CDATA[12.00 &euro;]]></charge_amount_formatted>  
    <paypal>
      <env>production</env>  
      <client>
        <production>4febe4d22560b09c50e22a5fc922761e-311ab18987a46700dfd7072304d040b5</production>  
      </client>  
    </paypal>  
    <discounted_formatted>0.00</discounted_formatted>  
    <discounted1_formatted>0.00</discounted1_formatted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/coupons/check?coupon=4de33f36c8418be3589c85285eccc6b2&amount=100&format=txt

Query parameters

coupon = 4de33f36c8418be3589c85285eccc6b2
amount = 100
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_valid=1
result_description=Test coupon for PayPal
result_params_expiration=2025-12-31T13:13:00+01:00
result_params_en=Test coupon for PayPal
result_params_it=Coupon di prova per PayPal
result_params_plan=pro, business
result_params_charge_amount=12
result_params_public_plan=Pro, Business
result_amount=100
result_amount1=0
result_discounted=0
result_discounted1=0
result_is_100p_discount=1
result_charge_amount=12
result_charge_amount_formatted=12.00 &euro;
result_paypal_env=production
result_paypal_client_production=4febe4d22560b09c50e22a5fc922761e-311ab18987a46700dfd7072304d040b5
result_discounted_formatted=0.00
result_discounted1_formatted=0.00

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/coupons/check?coupon=4de33f36c8418be3589c85285eccc6b2&amount=100&format=plain

Query parameters

coupon = 4de33f36c8418be3589c85285eccc6b2
amount = 100
format = plain

Response

1
Test coupon for PayPal
2025-12-31T13:13:00+01:00
Test coupon for PayPal
Coupon di prova per PayPal
pro, business
12
Pro, Business
100
0
0
0
1
12
12.00 &euro;
production
4febe4d22560b09c50e22a5fc922761e-311ab18987a46700dfd7072304d040b5
0.00
0.00
Required parameters
parameterdescription
couponSTRINGCoupon code. This can be a comma separated list of coupons for stackable coupons.
Optional parameters
parameterdescription
amountSTRINGif this parameter is passed, the method returns the amount requested after applying the coupon
amount1STRINGif this parameter is passed, the method returns the amount requested after applying the coupon
Return values
parameterdescription
amountecho back of the input parameter amount
amount1echo back of the input parameter amount1
charge_amount[OPTIONAL] returned only if the coupon requires an immediate charge
charge_amount_formatted[OPTIONAL] formatted version of charge_amount
descriptiondescription of the coupon if available, empty otherwise
discountedthe amount requested after applying the coupon to parameter amount
discounted1the amount requested after applying the coupon to parameter amount1
discounted1_formattedformatted version of discounted1
discounted_formattedformatted version of discounted
is_100p_discount1 if the coupon applies a 100% discount, 0 otherwise
paramsarray containing extended parameters for the coupon
paypal[OPTIONAL] array containing information on the PayPal client to be used to precess payments, please see PayPal API documentation for details
valid1 if the coupon is valid, 0 otherwise

/plans/customers

/plans/customers/add

access: [WRITE]

This method creates a customer on the payment gateaway.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/customers/add

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "added": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/customers/add?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <added>1</added>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/customers/add?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_added=1

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/customers/add?format=plain

Query parameters

format = plain

Response

1
Return values
parameterdescription
added1 on success, 0 otherwise

/plans/customers/balance_transactions

access: [READ]

This method returns the list of balance transactions for the current customer. Transactions are returned in reverse order (most recent first).

Example 1 (json)

Request

https://joturl.com/a/i1/plans/customers/balance_transactions

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "added": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/customers/balance_transactions?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <added>1</added>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/customers/balance_transactions?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_added=1

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/customers/balance_transactions?format=plain

Query parameters

format = plain

Response

1
Optional parameters
parameterdescription
startingSTRINGit is an ID (returned in data) that defines the point in the list from which to extract transactions, to be used in pagination
Return values
parameterdescription
datalist of transactions

/plans/customers/info

access: [READ]

This method returns payment information about the user.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/customers/info

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "dc8a467cb41eb57fe136a72664bb824f",
    "created": "2018-08-07T20:33:07+02:00",
    "updated": "2018-08-07T20:33:07+02:00",
    "payments": [
      {
        "token": "762b537139612b474a7641504a6147354b30486834787a6f5666343473794d7855702b6e456d494f5a65667974535a41474f6f575378317836383976356a4c55",
        "country": "US",
        "created": "2018-12-06T23:31:24+01:00",
        "updated": "2018-12-06T23:31:24+01:00",
        "default": 1,
        "image": "",
        "subscriptions": 0,
        "brand": "Visa",
        "type": "visa",
        "last4": "4242",
        "expiration": {
          "month": 4,
          "year": 2024
        }
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/customers/info?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>dc8a467cb41eb57fe136a72664bb824f</id>  
    <created>2018-08-07T20:33:07+02:00</created>  
    <updated>2018-08-07T20:33:07+02:00</updated>  
    <payments>
      <i0>
        <token>762b537139612b474a7641504a6147354b30486834787a6f5666343473794d7855702b6e456d494f5a65667974535a41474f6f575378317836383976356a4c55</token>  
        <country>US</country>  
        <created>2018-12-06T23:31:24+01:00</created>  
        <updated>2018-12-06T23:31:24+01:00</updated>  
        <default>1</default>  
        <image></image>  
        <subscriptions>0</subscriptions>  
        <brand>Visa</brand>  
        <type>visa</type>  
        <last4>4242</last4>  
        <expiration>
          <month>4</month>  
          <year>2024</year>  
        </expiration>  
      </i0>  
    </payments>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/customers/info?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=dc8a467cb41eb57fe136a72664bb824f
result_created=2018-08-07T20:33:07+02:00
result_updated=2018-08-07T20:33:07+02:00
result_payments_0_token=762b537139612b474a7641504a6147354b30486834787a6f5666343473794d7855702b6e456d494f5a65667974535a41474f6f575378317836383976356a4c55
result_payments_0_country=US
result_payments_0_created=2018-12-06T23:31:24+01:00
result_payments_0_updated=2018-12-06T23:31:24+01:00
result_payments_0_default=1
result_payments_0_image=
result_payments_0_subscriptions=0
result_payments_0_brand=Visa
result_payments_0_type=visa
result_payments_0_last4=4242
result_payments_0_expiration_month=4
result_payments_0_expiration_year=2024

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/customers/info?format=plain

Query parameters

format = plain

Response

dc8a467cb41eb57fe136a72664bb824f
2018-08-07T20:33:07+02:00
2018-08-07T20:33:07+02:00
762b537139612b474a7641504a6147354b30486834787a6f5666343473794d7855702b6e456d494f5a65667974535a41474f6f575378317836383976356a4c55
US
2018-12-06T23:31:24+01:00
2018-12-06T23:31:24+01:00
default:1

0
Visa
visa
4242
4
2024
Return values
parameterdescription
createddate on which the customer was created
idcustomer ID on the payment gateway
paymentsobject containing payment information
updateddate on which the customer was updated

/plans/info

access: [READ]

This method returns information about the user's plan.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/info

Response

{
  "id": "adaf262f58fa3b47efef26db7523ac7a",
  "name": "business",
  "annually_cost": 135,
  "monthly_cost": 169,
  "events_per_month": 500000,
  "tracking_links": 100000,
  "stats_permanency_days": 730,
  "max_users": 30,
  "max_permissions": 6,
  "max_brands": 70,
  "has_smart_balancer": 1,
  "has_split_testing": 1,
  "has_smart_redirector": 1,
  "max_qrcode_templates": 100,
  "max_projects": "",
  "has_conversions": 1,
  "has_timed_urls": 1,
  "force_brand_on_ctas": 0,
  "has_watchdog_ping": 1,
  "has_watchdog_advanced": 1,
  "number_of_ctas": "",
  "max_banners": "",
  "custom_domains": 30,
  "email_support": 1,
  "priority_email_support": 1,
  "has_security_monitor": 1,
  "has_cfm": 1,
  "has_custom_aliases": 1,
  "has_masking": 1,
  "has_jotbar": 1,
  "has_custom_logo_in_reports": 1,
  "has_custom_css_cta": 1,
  "has_setup_assistance_and_training": 0,
  "has_custom_invoicing": 0,
  "has_enterprise_sla": 0,
  "has_customizations_and_integrations": 0,
  "has_digital_marketing_advice": 0,
  "has_minipages": 1,
  "has_deeplinks": 1,
  "has_easydeeplinks": 1,
  "has_preview": 1,
  "public_name": "Business",
  "has_utm_builder": 1,
  "max_utm_templates": 30,
  "has_remarketing": "",
  "has_whatsapp": 1,
  "has_instaurl": 0,
  "has_selfdestruction": 0,
  "has_cloaking": 1,
  "has_advanced_security": 0,
  "is_monthly": 1,
  "status": "green",
  "trial_left_days": 30,
  "events": "",
  "is_monitored": 1,
  "can_manage_plans": 1,
  "can_manage_billing": 1,
  "email_sent": 0,
  "subscription_status": "ACTIVE",
  "subscription_creation": "2018-08-13T23:16:14+02:00",
  "subscription_next_billing_date": "2018-12-27T11:58:57+01:00",
  "subscription_billing_end_date": "2018-12-27T11:58:57+01:00",
  "subscription_never_expires": 1,
  "subscription_trial_period": 0,
  "subscription_first_billing_date": "2018-12-27T11:58:57+01:00",
  "subscription_balance": 0,
  "max_gdpr_templates": 10,
  "has_gdpr_custom_consent": 1,
  "max_media": 100000,
  "max_media_size": 10000000,
  "cdnbytes_per_month": 100000000000,
  "api_rate_limits": {
    "primary": {
      "limit": 500,
      "unit": "HOUR"
    },
    "secondary": {
      "limit": 50000,
      "unit": "DAY"
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/info?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <id>adaf262f58fa3b47efef26db7523ac7a</id>  
  <name>business</name>  
  <annually_cost>135</annually_cost>  
  <monthly_cost>169</monthly_cost>  
  <events_per_month>500000</events_per_month>  
  <tracking_links>100000</tracking_links>  
  <stats_permanency_days>730</stats_permanency_days>  
  <max_users>30</max_users>  
  <max_permissions>6</max_permissions>  
  <max_brands>70</max_brands>  
  <has_smart_balancer>1</has_smart_balancer>  
  <has_split_testing>1</has_split_testing>  
  <has_smart_redirector>1</has_smart_redirector>  
  <max_qrcode_templates>100</max_qrcode_templates>  
  <max_projects></max_projects>  
  <has_conversions>1</has_conversions>  
  <has_timed_urls>1</has_timed_urls>  
  <force_brand_on_ctas>0</force_brand_on_ctas>  
  <has_watchdog_ping>1</has_watchdog_ping>  
  <has_watchdog_advanced>1</has_watchdog_advanced>  
  <number_of_ctas></number_of_ctas>  
  <max_banners></max_banners>  
  <custom_domains>30</custom_domains>  
  <email_support>1</email_support>  
  <priority_email_support>1</priority_email_support>  
  <has_security_monitor>1</has_security_monitor>  
  <has_cfm>1</has_cfm>  
  <has_custom_aliases>1</has_custom_aliases>  
  <has_masking>1</has_masking>  
  <has_jotbar>1</has_jotbar>  
  <has_custom_logo_in_reports>1</has_custom_logo_in_reports>  
  <has_custom_css_cta>1</has_custom_css_cta>  
  <has_setup_assistance_and_training>0</has_setup_assistance_and_training>  
  <has_custom_invoicing>0</has_custom_invoicing>  
  <has_enterprise_sla>0</has_enterprise_sla>  
  <has_customizations_and_integrations>0</has_customizations_and_integrations>  
  <has_digital_marketing_advice>0</has_digital_marketing_advice>  
  <has_minipages>1</has_minipages>  
  <has_deeplinks>1</has_deeplinks>  
  <has_easydeeplinks>1</has_easydeeplinks>  
  <has_preview>1</has_preview>  
  <public_name>Business</public_name>  
  <has_utm_builder>1</has_utm_builder>  
  <max_utm_templates>30</max_utm_templates>  
  <has_remarketing></has_remarketing>  
  <has_whatsapp>1</has_whatsapp>  
  <has_instaurl>0</has_instaurl>  
  <has_selfdestruction>0</has_selfdestruction>  
  <has_cloaking>1</has_cloaking>  
  <has_advanced_security>0</has_advanced_security>  
  <is_monthly>1</is_monthly>  
  <status>green</status>  
  <trial_left_days>30</trial_left_days>  
  <events></events>  
  <is_monitored>1</is_monitored>  
  <can_manage_plans>1</can_manage_plans>  
  <can_manage_billing>1</can_manage_billing>  
  <email_sent>0</email_sent>  
  <subscription_status>ACTIVE</subscription_status>  
  <subscription_creation>2018-08-13T23:16:14+02:00</subscription_creation>  
  <subscription_next_billing_date>2018-12-27T11:58:57+01:00</subscription_next_billing_date>  
  <subscription_billing_end_date>2018-12-27T11:58:57+01:00</subscription_billing_end_date>  
  <subscription_never_expires>1</subscription_never_expires>  
  <subscription_trial_period>0</subscription_trial_period>  
  <subscription_first_billing_date>2018-12-27T11:58:57+01:00</subscription_first_billing_date>  
  <subscription_balance>0</subscription_balance>  
  <max_gdpr_templates>10</max_gdpr_templates>  
  <has_gdpr_custom_consent>1</has_gdpr_custom_consent>  
  <max_media>100000</max_media>  
  <max_media_size>10000000</max_media_size>  
  <cdnbytes_per_month>100000000000</cdnbytes_per_month>  
  <api_rate_limits>
    <primary>
      <limit>500</limit>  
      <unit>HOUR</unit>  
    </primary>  
    <secondary>
      <limit>50000</limit>  
      <unit>DAY</unit>  
    </secondary>  
  </api_rate_limits>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/info?format=txt

Query parameters

format = txt

Response

id=adaf262f58fa3b47efef26db7523ac7a
name=business
annually_cost=135
monthly_cost=169
events_per_month=500000
tracking_links=100000
stats_permanency_days=730
max_users=30
max_permissions=6
max_brands=70
has_smart_balancer=1
has_split_testing=1
has_smart_redirector=1
max_qrcode_templates=100
max_projects=
has_conversions=1
has_timed_urls=1
force_brand_on_ctas=0
has_watchdog_ping=1
has_watchdog_advanced=1
number_of_ctas=
max_banners=
custom_domains=30
email_support=1
priority_email_support=1
has_security_monitor=1
has_cfm=1
has_custom_aliases=1
has_masking=1
has_jotbar=1
has_custom_logo_in_reports=1
has_custom_css_cta=1
has_setup_assistance_and_training=0
has_custom_invoicing=0
has_enterprise_sla=0
has_customizations_and_integrations=0
has_digital_marketing_advice=0
has_minipages=1
has_deeplinks=1
has_easydeeplinks=1
has_preview=1
public_name=Business
has_utm_builder=1
max_utm_templates=30
has_remarketing=
has_whatsapp=1
has_instaurl=0
has_selfdestruction=0
has_cloaking=1
has_advanced_security=0
is_monthly=1
status=green
trial_left_days=30
events=
is_monitored=1
can_manage_plans=1
can_manage_billing=1
email_sent=0
subscription_status=ACTIVE
subscription_creation=2018-08-13T23:16:14+02:00
subscription_next_billing_date=2018-12-27T11:58:57+01:00
subscription_billing_end_date=2018-12-27T11:58:57+01:00
subscription_never_expires=1
subscription_trial_period=0
subscription_first_billing_date=2018-12-27T11:58:57+01:00
subscription_balance=0
max_gdpr_templates=10
has_gdpr_custom_consent=1
max_media=100000
max_media_size=10000000
cdnbytes_per_month=100000000000
api_rate_limits_primary_limit=500
api_rate_limits_primary_unit=HOUR
api_rate_limits_secondary_limit=50000
api_rate_limits_secondary_unit=DAY

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/info?format=plain

Query parameters

format = plain

Response

adaf262f58fa3b47efef26db7523ac7a
business
135
169
500000
100000
730
30
6
70
1
1
1
100

1
1
0
1
1


30
1
1
1
1
1
1
1
1
1
0
0
0
0
0
1
1
1
1
Business
1
30

1
0
0
1
0
1
green
30

1
1
1
0
ACTIVE
2018-08-13T23:16:14+02:00
2018-12-27T11:58:57+01:00
2018-12-27T11:58:57+01:00
1
0
2018-12-27T11:58:57+01:00
0
10
1
100000
10000000
100000000000
500
HOUR
50000
DAY
Return values
parameterdescription
annually_costcost if paid annually
api_rate_limitsAPI rate limits, see i1/apis/limits for details
can_manage_billing1 if the user can change the billing information and download invoices, 0 otherwise
can_manage_plans1 if the user can change the current plan and subscription, 0 otherwise
cdnbytes_per_monthavailable CDN bytes per month
custom_domainsmaximum number of custom domains
email_sentif an email was sent after a change of status, in any case emails are sent with a frequency of no less than 72 hours
email_support1 if email support is available, 0 otherwise
eventsevents used in the last 30 days
events_per_monthavailable events per month
force_brand_on_ctas1 if the JotUrl brand is forced to be shown on CTAs, 0 otherwise
has_advanced_security1 if the advanced security (permissions) is available, 0 otherwise
has_cfm1 if click fraud protection is available, 0 otherwise
has_cloaking1 if the cloaking option is available, 0 otherwise
has_conversions1 if conversions are available, 0 otherwise
has_custom_aliases1 if custom aliases are available, 0 otherwise
has_custom_css_cta1 if custom CSS on CTAs is available, 0 otherwise
has_custom_invoicing1 if custom invoicing is available, 0 otherwise
has_custom_logo_in_reports1 if custom logo in reports is available, 0 otherwise
has_customizations_and_integrations1 if customizations and integrations is available, 0 otherwise
has_deeplinks1 if deep links are available, 0 otherwise
has_digital_marketing_advice1 if digital marketing advice is available, 0 otherwise
has_easydeeplinks1 if the option easy deep links is available, 0 otherwise
has_enterprise_sla1 if enterprise SLA is available, 0 otherwise
has_gdpr_custom_consent1 if GDPR consent can be customized, 0 otherwise
has_instaurl1 if JotBio (InstaUrl) is available, 0 otherwise
has_jotbar1 if JotBar is available, 0 otherwise
has_masking1 if masking is available, 0 otherwise
has_minipages1 if minipages are available, 0 otherwise
has_preview1 if link preview edit (Open Graph tags) is available, 0 otherwise
has_remarketingnumber of available remarketing pixels, empty means "unlimited", 0 means no remarketing pixel available
has_security_monitor1 if security monitor is available, 0 otherwise
has_selfdestruction1 if the self destruction option is available, 0 otherwise
has_setup_assistance_and_training1 if setup assistance and training is available, 0 otherwise
has_smart_balancer1 if smart balanger is available, 0 otherwise
has_smart_redirector1 if smart redirector is available, 0 otherwise
has_split_testing1 if split testing is available, 0 otherwise
has_timed_urls1 if timed urls is available, 0 otherwise
has_utm_builder1 if UTM builder is available, 0 otherwise
has_watchdog_advanced1 if advanced Watchdog is available, 0 otherwise
has_watchdog_ping1 if basic Watchdog is available, 0 otherwise
has_whatsapp1 if WhatsUrl is available, 0 otherwise
idID of the subscribed profile
is_monitored1 if the user profile is automatically monitored, 0 otherwise
is_monthly1 billing is made monthly, 0 for annually billing
max_brandsmaximum number of brands
max_gdpr_templatesmaximum available GDPR templates
max_mediamaximum number of media in the media library
max_media_sizemaximum size of the the media library (in bytes)
max_permissionsmaximum number of permissions for your team members
max_qrcode_templatesmaximum number of QR-Code templates
max_usersmaximum number of users (including the admin user)
max_utm_templatesmaximum number of UTM templates
monthly_costcost per month if paid monthly
namename of the profile
priority_email_support1 if priority email support is available, 0 otherwise
public_nameuser-friendly name of the profile
stats_permanency_daysanalytics are stored for this number of days
statusstatus for the user, it can be: green if the user is using less than 80% of the available events, yellow if the user is using between the 80% (included) and 110% (excluded) of the available events, red if the user is using between the 110% (included) and 150% (excluded) of the available events, black if the user is using more than the 150% (included) of the available events or if the user is continuosly in the red status for at least 144 hours
subscription_balance[OPTIONAL] any remaining credit that will be used for future payments, available only for monitored and paid profile
subscription_billing_end_date[OPTIONAL] end of the current period that the subscription has been invoiced for; at the end of this period, a new invoice will be created, available only for monitored and paid profile
subscription_creation[OPTIONAL] time at which the subscription was created, available only for monitored and paid profile
subscription_first_billing_date[OPTIONAL] date at which a new invoice will be generated for the subscription (for trialing subscriptions), available only for monitored and paid profile
subscription_never_expires[OPTIONAL] 0 if the subscription is scheduled to be canceled at the end of the current billing period, 1 otherwise, available only for monitored and paid profile
subscription_next_billing_date[OPTIONAL] date at which a new invoice will be generated for the subscription, available only for monitored and paid profile
subscription_status[subscription status, it can be one of [TRIALING, INCOMPLETE, INCOMPLETE_EXPIRED, ACTIVE, PAST_DUE, CANCELED, UNPAID]
subscription_trial_period[OPTIONAL] 1 if the subscription is in its trial period, 0 otherwise, available only for monitored and paid profile
tracking_linksmaximum number of tracking links
trial_left_daysavailable maximum trial days for the user

/plans/invoices

/plans/invoices/count

access: [READ]

This method returns the number of invoices issued to the logged user.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/invoices/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 703
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/invoices/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>703</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/invoices/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=703

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/invoices/count?format=plain

Query parameters

format = plain

Response

703
Optional parameters
parameterdescription
is_credit_noteSTRINGcount only credit notes
searchSTRINGfilters invoices to be extracted by searching them
vat_treatmentSTRINGfilter invoices by VAT treatment
yearINTEGERfilter invoices by year
Return values
parameterdescription
countthe total number of invoices issued to the logged user

/plans/invoices/get

access: [READ]

This method returns an invoice for the logged user.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/invoices/get?id=55d801a40176553b395b5b685446cb58&pdf=1

Query parameters

 id = 55d801a40176553b395b5b685446cb58
pdf = 1

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "10C-CC\/2019",
    "pdf": "[PDF]"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/invoices/get?id=55d801a40176553b395b5b685446cb58&pdf=1&format=xml

Query parameters

    id = 55d801a40176553b395b5b685446cb58
   pdf = 1
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>10C-CC/2019</id>  
    <pdf>[PDF]</pdf>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/invoices/get?id=55d801a40176553b395b5b685446cb58&pdf=1&format=txt

Query parameters

    id = 55d801a40176553b395b5b685446cb58
   pdf = 1
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=10C-CC/2019
result_pdf=[PDF]

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/invoices/get?id=55d801a40176553b395b5b685446cb58&pdf=1&format=plain

Query parameters

    id = 55d801a40176553b395b5b685446cb58
   pdf = 1
format = plain

Response

10C-CC/2019
[PDF]
Required parameters
parameterdescription
idIDinternal ID of the invoice
Optional parameters
parameterdescription
pdfBOOLEAN1 to generate a PDF (returned as binary string), 0 to generate the corresponding HTML (default value: 0)
Return values
parameterdescription
htmlHTML for the invoice if pdf = 0
idID of the invoice
pdfPDF for the invoice if pdf = 1

/plans/invoices/list

access: [READ]

This method returns a list of invoices associated to the user.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/invoices/list

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 1,
    "data": [
      {
        "id": "5376aa018d564b98262b1015a8f07a3a",
        "profile_id": "f910d4b16af0df2e3ced5b1a85024e62",
        "profile_name": "planname",
        "public_name": "Plan Name",
        "amount": "9.00",
        "created": "2019-06-20 08:57:21",
        "invoice_datetime": "2019-06-20 09:57:38",
        "billing_period_start": "2019-06-20 08:57:21",
        "billing_period_end": "2019-07-20 08:57:21",
        "vat_treatment": "INTRA_EU_BUSINESS",
        "year": 2019,
        "sequence": 11,
        "address": {
          "is_business": 1,
          "name": "Company name",
          "address_address": "Company address",
          "postal_code": "DH8 6ZL",
          "city": "MEDOMSLEY",
          "country_code": "UK",
          "vat_id": "2380238238E123",
          "cf": "",
          "pec": "",
          "recipient_code": ""
        },
        "promo_code": "",
        "promo_amount": "",
        "invoice_template": "",
        "invoice_description": "",
        "refund_amount": "",
        "refund_invoice_id": "",
        "refund_vat_treatment": "",
        "refund_year": "",
        "refund_sequence": "",
        "refund_datetime": "",
        "invoice_id": "11B-EU\/2019",
        "is_credit_note": 0
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/invoices/list?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>1</count>  
    <data>
      <i0>
        <id>5376aa018d564b98262b1015a8f07a3a</id>  
        <profile_id>f910d4b16af0df2e3ced5b1a85024e62</profile_id>  
        <profile_name>planname</profile_name>  
        <public_name>Plan Name</public_name>  
        <amount>9.00</amount>  
        <created>2019-06-20 08:57:21</created>  
        <invoice_datetime>2019-06-20 09:57:38</invoice_datetime>  
        <billing_period_start>2019-06-20 08:57:21</billing_period_start>  
        <billing_period_end>2019-07-20 08:57:21</billing_period_end>  
        <vat_treatment>INTRA_EU_BUSINESS</vat_treatment>  
        <year>2019</year>  
        <sequence>11</sequence>  
        <address>
          <is_business>1</is_business>  
          <name>Company name</name>  
          <address_address>Company address</address_address>  
          <postal_code>DH8 6ZL</postal_code>  
          <city>MEDOMSLEY</city>  
          <country_code>UK</country_code>  
          <vat_id>2380238238E123</vat_id>  
          <cf></cf>  
          <pec></pec>  
          <recipient_code></recipient_code>  
        </address>  
        <promo_code></promo_code>  
        <promo_amount></promo_amount>  
        <invoice_template></invoice_template>  
        <invoice_description></invoice_description>  
        <refund_amount></refund_amount>  
        <refund_invoice_id></refund_invoice_id>  
        <refund_vat_treatment></refund_vat_treatment>  
        <refund_year></refund_year>  
        <refund_sequence></refund_sequence>  
        <refund_datetime></refund_datetime>  
        <invoice_id>11B-EU/2019</invoice_id>  
        <is_credit_note>0</is_credit_note>  
      </i0>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/invoices/list?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=1
result_data_0_id=5376aa018d564b98262b1015a8f07a3a
result_data_0_profile_id=f910d4b16af0df2e3ced5b1a85024e62
result_data_0_profile_name=planname
result_data_0_public_name=Plan Name
result_data_0_amount=9.00
result_data_0_created=2019-06-20 08:57:21
result_data_0_invoice_datetime=2019-06-20 09:57:38
result_data_0_billing_period_start=2019-06-20 08:57:21
result_data_0_billing_period_end=2019-07-20 08:57:21
result_data_0_vat_treatment=INTRA_EU_BUSINESS
result_data_0_year=2019
result_data_0_sequence=11
result_data_0_address_is_business=1
result_data_0_address_name=Company name
result_data_0_address_address_address=Company address
result_data_0_address_postal_code=DH8 6ZL
result_data_0_address_city=MEDOMSLEY
result_data_0_address_country_code=UK
result_data_0_address_vat_id=2380238238E123
result_data_0_address_cf=
result_data_0_address_pec=
result_data_0_address_recipient_code=
result_data_0_promo_code=
result_data_0_promo_amount=
result_data_0_invoice_template=
result_data_0_invoice_description=
result_data_0_refund_amount=
result_data_0_refund_invoice_id=
result_data_0_refund_vat_treatment=
result_data_0_refund_year=
result_data_0_refund_sequence=
result_data_0_refund_datetime=
result_data_0_invoice_id=11B-EU/2019
result_data_0_is_credit_note=0

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/invoices/list?format=plain

Query parameters

format = plain

Response

1
5376aa018d564b98262b1015a8f07a3a
f910d4b16af0df2e3ced5b1a85024e62
planname
Plan Name
9.00
2019-06-20 08:57:21
2019-06-20 09:57:38
2019-06-20 08:57:21
2019-07-20 08:57:21
INTRA_EU_BUSINESS
2019
11
1
Company name
Company address
DH8 6ZL
MEDOMSLEY
UK
2380238238E123













11B-EU/2019
0
Optional parameters
parameterdescription
idIDfilter invoice by ID
is_credit_noteSTRINGshow only credit notes
lengthINTEGERextracts this number of invoices (maxmimum allowed: 100)
searchSTRINGfilters invoices to be extracted by searching them
startINTEGERstarts to extract invoices from this position
vat_treatmentSTRINGfilter invoices by VAT treatment
yearINTEGERfilter invoices by year
Return values
parameterdescription
count[OPTIONAL] the total number of invoices available for the user, only returned if id is not passed
data
next[OPTIONAL] the URL to call to retrieve the next page of invoices when they are paged, returned only if at least one more invoice is available

/plans/invoices/next

access: [READ]

This method returns the next upcoming invoice for the logged user and, if available, information about discounts that will applied.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/invoices/next

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "upcoming_amount_due": 9,
    "upcoming_invoice_date": "2025-07-27 16:53:14"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/invoices/next?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <upcoming_amount_due>9</upcoming_amount_due>  
    <upcoming_invoice_date>2025-07-27 16:53:14</upcoming_invoice_date>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/invoices/next?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_upcoming_amount_due=9
result_upcoming_invoice_date=2025-07-27 16:53:14

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/invoices/next?format=plain

Query parameters

format = plain

Response

9
2025-07-27 16:53:14
Return values
parameterdescription
coupon_amount_offdiscount amout that will applied to the invoice, if available
coupon_descriptiondescription for the coupon, if available
coupon_endthe date/time that the coupon will end, if available
coupon_idcoupon code that will applied to the invoice, if available
coupon_percent_offpercentage discount that will applied to the invoice, if available
coupon_startdate/time that the coupon was applied, if available
scheduled_amount_duethe amount of the next scheduled invoice (in case of a recent payment waiting to be completed)
scheduled_invoice_datethe date/time at which the scheduled invoice will be issued
upcoming_amount_duethe amount of the upcoming invoice
upcoming_invoice_datethe date/time at which the invoice will be issued

/plans/list

access: [READ]

This method returns a list of available plans for the current user.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/list

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": [
    {
      "id": "8173428a373f656a75fc765a524ca3d4",
      "is_preferred": 0,
      "name": "free",
      "reference_name": "",
      "annually_cost": 0,
      "monthly_cost": 0,
      "events_per_month": 1000,
      "tracking_links": 200,
      "stats_permanency_days": 30,
      "max_users": 1,
      "max_brands": 1,
      "has_smart_balancer": 0,
      "has_split_testing": 0,
      "has_smart_redirector": 0,
      "max_qrcode_templates": 1,
      "max_projects": 5,
      "has_conversions": 0,
      "has_timed_urls": 0,
      "force_brand_on_ctas": 1,
      "has_watchdog_ping": 1,
      "has_watchdog_advanced": 0,
      "number_of_ctas": "",
      "max_banners": 0,
      "custom_domains": 0,
      "email_support": 1,
      "priority_email_support": 0,
      "has_security_monitor": 0,
      "has_cfm": 0,
      "has_custom_aliases": 1,
      "has_masking": 0,
      "has_jotbar": 0,
      "has_custom_logo_in_reports": 0,
      "has_custom_css_cta": 0,
      "has_setup_assistance_and_training": 0,
      "has_custom_invoicing": 0,
      "has_enterprise_sla": 0,
      "has_customizations_and_integrations": 0,
      "has_digital_marketing_advice": 0,
      "trial_days": 0,
      "has_minipages": 0,
      "has_deeplinks": 0,
      "has_easydeeplinks": 0,
      "has_preview": 0,
      "public_name": "Free",
      "has_utm_builder": 0,
      "has_remarketing": 1,
      "has_whatsapp": 0,
      "has_instaurl": 0,
      "has_selfdestruction": 0,
      "user_profile": 0,
      "reserved_for_user": 0,
      "max_media": 0,
      "max_media_size": 0,
      "cdnbytes_per_month": 0
    },
    {
      "id": "8e8d3c71eb12dcff5ea7f26de78f03c3",
      "is_preferred": 0,
      "name": "growth",
      "reference_name": "",
      "annually_cost": 7,
      "monthly_cost": 9,
      "events_per_month": 5000,
      "tracking_links": 2000,
      "stats_permanency_days": 365,
      "max_users": 3,
      "max_brands": 5,
      "has_smart_balancer": 1,
      "has_split_testing": 1,
      "has_smart_redirector": 1,
      "max_qrcode_templates": 10,
      "max_projects": "",
      "has_conversions": 1,
      "has_timed_urls": 1,
      "force_brand_on_ctas": 0,
      "has_watchdog_ping": 1,
      "has_watchdog_advanced": 0,
      "number_of_ctas": "",
      "max_banners": "",
      "custom_domains": 3,
      "email_support": 1,
      "priority_email_support": 0,
      "has_security_monitor": 1,
      "has_cfm": 1,
      "has_custom_aliases": 1,
      "has_masking": 1,
      "has_jotbar": 1,
      "has_custom_logo_in_reports": 0,
      "has_custom_css_cta": 0,
      "has_setup_assistance_and_training": 0,
      "has_custom_invoicing": 0,
      "has_enterprise_sla": 0,
      "has_customizations_and_integrations": 0,
      "has_digital_marketing_advice": 0,
      "trial_days": 14,
      "has_minipages": 1,
      "has_deeplinks": 1,
      "has_easydeeplinks": 1,
      "has_preview": 1,
      "public_name": "Growth",
      "has_utm_builder": 1,
      "has_remarketing": 5,
      "has_whatsapp": 1,
      "has_instaurl": 0,
      "has_selfdestruction": 0,
      "user_profile": 0,
      "reserved_for_user": 0,
      "max_media": 100000,
      "max_media_size": 10000000,
      "cdnbytes_per_month": 100000000000
    }
  ]
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/list?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <i0>
      <id>8173428a373f656a75fc765a524ca3d4</id>  
      <is_preferred>0</is_preferred>  
      <name>free</name>  
      <reference_name></reference_name>  
      <annually_cost>0</annually_cost>  
      <monthly_cost>0</monthly_cost>  
      <events_per_month>1000</events_per_month>  
      <tracking_links>200</tracking_links>  
      <stats_permanency_days>30</stats_permanency_days>  
      <max_users>1</max_users>  
      <max_brands>1</max_brands>  
      <has_smart_balancer>0</has_smart_balancer>  
      <has_split_testing>0</has_split_testing>  
      <has_smart_redirector>0</has_smart_redirector>  
      <max_qrcode_templates>1</max_qrcode_templates>  
      <max_projects>5</max_projects>  
      <has_conversions>0</has_conversions>  
      <has_timed_urls>0</has_timed_urls>  
      <force_brand_on_ctas>1</force_brand_on_ctas>  
      <has_watchdog_ping>1</has_watchdog_ping>  
      <has_watchdog_advanced>0</has_watchdog_advanced>  
      <number_of_ctas></number_of_ctas>  
      <max_banners>0</max_banners>  
      <custom_domains>0</custom_domains>  
      <email_support>1</email_support>  
      <priority_email_support>0</priority_email_support>  
      <has_security_monitor>0</has_security_monitor>  
      <has_cfm>0</has_cfm>  
      <has_custom_aliases>1</has_custom_aliases>  
      <has_masking>0</has_masking>  
      <has_jotbar>0</has_jotbar>  
      <has_custom_logo_in_reports>0</has_custom_logo_in_reports>  
      <has_custom_css_cta>0</has_custom_css_cta>  
      <has_setup_assistance_and_training>0</has_setup_assistance_and_training>  
      <has_custom_invoicing>0</has_custom_invoicing>  
      <has_enterprise_sla>0</has_enterprise_sla>  
      <has_customizations_and_integrations>0</has_customizations_and_integrations>  
      <has_digital_marketing_advice>0</has_digital_marketing_advice>  
      <trial_days>0</trial_days>  
      <has_minipages>0</has_minipages>  
      <has_deeplinks>0</has_deeplinks>  
      <has_easydeeplinks>0</has_easydeeplinks>  
      <has_preview>0</has_preview>  
      <public_name>Free</public_name>  
      <has_utm_builder>0</has_utm_builder>  
      <has_remarketing>1</has_remarketing>  
      <has_whatsapp>0</has_whatsapp>  
      <has_instaurl>0</has_instaurl>  
      <has_selfdestruction>0</has_selfdestruction>  
      <user_profile>0</user_profile>  
      <reserved_for_user>0</reserved_for_user>  
      <max_media>0</max_media>  
      <max_media_size>0</max_media_size>  
      <cdnbytes_per_month>0</cdnbytes_per_month>  
    </i0>  
    <i1>
      <id>8e8d3c71eb12dcff5ea7f26de78f03c3</id>  
      <is_preferred>0</is_preferred>  
      <name>growth</name>  
      <reference_name></reference_name>  
      <annually_cost>7</annually_cost>  
      <monthly_cost>9</monthly_cost>  
      <events_per_month>5000</events_per_month>  
      <tracking_links>2000</tracking_links>  
      <stats_permanency_days>365</stats_permanency_days>  
      <max_users>3</max_users>  
      <max_brands>5</max_brands>  
      <has_smart_balancer>1</has_smart_balancer>  
      <has_split_testing>1</has_split_testing>  
      <has_smart_redirector>1</has_smart_redirector>  
      <max_qrcode_templates>10</max_qrcode_templates>  
      <max_projects></max_projects>  
      <has_conversions>1</has_conversions>  
      <has_timed_urls>1</has_timed_urls>  
      <force_brand_on_ctas>0</force_brand_on_ctas>  
      <has_watchdog_ping>1</has_watchdog_ping>  
      <has_watchdog_advanced>0</has_watchdog_advanced>  
      <number_of_ctas></number_of_ctas>  
      <max_banners></max_banners>  
      <custom_domains>3</custom_domains>  
      <email_support>1</email_support>  
      <priority_email_support>0</priority_email_support>  
      <has_security_monitor>1</has_security_monitor>  
      <has_cfm>1</has_cfm>  
      <has_custom_aliases>1</has_custom_aliases>  
      <has_masking>1</has_masking>  
      <has_jotbar>1</has_jotbar>  
      <has_custom_logo_in_reports>0</has_custom_logo_in_reports>  
      <has_custom_css_cta>0</has_custom_css_cta>  
      <has_setup_assistance_and_training>0</has_setup_assistance_and_training>  
      <has_custom_invoicing>0</has_custom_invoicing>  
      <has_enterprise_sla>0</has_enterprise_sla>  
      <has_customizations_and_integrations>0</has_customizations_and_integrations>  
      <has_digital_marketing_advice>0</has_digital_marketing_advice>  
      <trial_days>14</trial_days>  
      <has_minipages>1</has_minipages>  
      <has_deeplinks>1</has_deeplinks>  
      <has_easydeeplinks>1</has_easydeeplinks>  
      <has_preview>1</has_preview>  
      <public_name>Growth</public_name>  
      <has_utm_builder>1</has_utm_builder>  
      <has_remarketing>5</has_remarketing>  
      <has_whatsapp>1</has_whatsapp>  
      <has_instaurl>0</has_instaurl>  
      <has_selfdestruction>0</has_selfdestruction>  
      <user_profile>0</user_profile>  
      <reserved_for_user>0</reserved_for_user>  
      <max_media>100000</max_media>  
      <max_media_size>10000000</max_media_size>  
      <cdnbytes_per_month>100000000000</cdnbytes_per_month>  
    </i1>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/list?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_0_id=8173428a373f656a75fc765a524ca3d4
result_0_is_preferred=0
result_0_name=free
result_0_reference_name=
result_0_annually_cost=0
result_0_monthly_cost=0
result_0_events_per_month=1000
result_0_tracking_links=200
result_0_stats_permanency_days=30
result_0_max_users=1
result_0_max_brands=1
result_0_has_smart_balancer=0
result_0_has_split_testing=0
result_0_has_smart_redirector=0
result_0_max_qrcode_templates=1
result_0_max_projects=5
result_0_has_conversions=0
result_0_has_timed_urls=0
result_0_force_brand_on_ctas=1
result_0_has_watchdog_ping=1
result_0_has_watchdog_advanced=0
result_0_number_of_ctas=
result_0_max_banners=0
result_0_custom_domains=0
result_0_email_support=1
result_0_priority_email_support=0
result_0_has_security_monitor=0
result_0_has_cfm=0
result_0_has_custom_aliases=1
result_0_has_masking=0
result_0_has_jotbar=0
result_0_has_custom_logo_in_reports=0
result_0_has_custom_css_cta=0
result_0_has_setup_assistance_and_training=0
result_0_has_custom_invoicing=0
result_0_has_enterprise_sla=0
result_0_has_customizations_and_integrations=0
result_0_has_digital_marketing_advice=0
result_0_trial_days=0
result_0_has_minipages=0
result_0_has_deeplinks=0
result_0_has_easydeeplinks=0
result_0_has_preview=0
result_0_public_name=Free
result_0_has_utm_builder=0
result_0_has_remarketing=1
result_0_has_whatsapp=0
result_0_has_instaurl=0
result_0_has_selfdestruction=0
result_0_user_profile=0
result_0_reserved_for_user=0
result_0_max_media=0
result_0_max_media_size=0
result_0_cdnbytes_per_month=0
result_1_id=8e8d3c71eb12dcff5ea7f26de78f03c3
result_1_is_preferred=0
result_1_name=growth
result_1_reference_name=
result_1_annually_cost=7
result_1_monthly_cost=9
result_1_events_per_month=5000
result_1_tracking_links=2000
result_1_stats_permanency_days=365
result_1_max_users=3
result_1_max_brands=5
result_1_has_smart_balancer=1
result_1_has_split_testing=1
result_1_has_smart_redirector=1
result_1_max_qrcode_templates=10
result_1_max_projects=
result_1_has_conversions=1
result_1_has_timed_urls=1
result_1_force_brand_on_ctas=0
result_1_has_watchdog_ping=1
result_1_has_watchdog_advanced=0
result_1_number_of_ctas=
result_1_max_banners=
result_1_custom_domains=3
result_1_email_support=1
result_1_priority_email_support=0
result_1_has_security_monitor=1
result_1_has_cfm=1
result_1_has_custom_aliases=1
result_1_has_masking=1
result_1_has_jotbar=1
result_1_has_custom_logo_in_reports=0
result_1_has_custom_css_cta=0
result_1_has_setup_assistance_and_training=0
result_1_has_custom_invoicing=0
result_1_has_enterprise_sla=0
result_1_has_customizations_and_integrations=0
result_1_has_digital_marketing_advice=0
result_1_trial_days=14
result_1_has_minipages=1
result_1_has_deeplinks=1
result_1_has_easydeeplinks=1
result_1_has_preview=1
result_1_public_name=Growth
result_1_has_utm_builder=1
result_1_has_remarketing=5
result_1_has_whatsapp=1
result_1_has_instaurl=0
result_1_has_selfdestruction=0
result_1_user_profile=0
result_1_reserved_for_user=0
result_1_max_media=100000
result_1_max_media_size=10000000
result_1_cdnbytes_per_month=100000000000

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/list?format=plain

Query parameters

format = plain

Response

8173428a373f656a75fc765a524ca3d4
0
free

0
0
1000
200
30
1
1
0
0
0
1
5
0
0
1
1
0

0
0
1
0
0
0
1
0
0
0
0
0
0
0
0
0
0
0
0
0
0
Free
0
1
0
0
0
0
0
0
0
0
8e8d3c71eb12dcff5ea7f26de78f03c3
0
growth

7
9
5000
2000
365
3
5
1
1
1
10

1
1
0
1
0


3
1
0
1
1
1
1
1
0
0
0
0
0
0
0
14
1
1
1
1
Growth
1
5
1
0
0
0
0
100000
10000000
100000000000
Optional parameters
parameterdescriptionmax length
idIDfilter by using the plan ID
is_preferredBOOLEAN1 to return preferred plan(s)
nameSTRINGfilter by using the plan name150
public_nameSTRINGfilter by using the plan user-friendly name150
Return values
parameterdescription
datalist of available plans for the current user

/plans/payments

/plans/payments/add

access: [WRITE]

This method add a payment method.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/payments/add?nonce=9fcdb374e15e3885c19484e8e7b6e7ad

Query parameters

nonce = 9fcdb374e15e3885c19484e8e7b6e7ad

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "added": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/payments/add?nonce=9fcdb374e15e3885c19484e8e7b6e7ad&format=xml

Query parameters

 nonce = 9fcdb374e15e3885c19484e8e7b6e7ad
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <added>1</added>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/payments/add?nonce=9fcdb374e15e3885c19484e8e7b6e7ad&format=txt

Query parameters

 nonce = 9fcdb374e15e3885c19484e8e7b6e7ad
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_added=1

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/payments/add?nonce=9fcdb374e15e3885c19484e8e7b6e7ad&format=plain

Query parameters

 nonce = 9fcdb374e15e3885c19484e8e7b6e7ad
format = plain

Response

1
Required parameters
parameterdescription
nonceSTRINGnonce that identifies the payment method, it comes from the payment gateway API
Optional parameters
parameterdescription
forceBOOLEANforce the attachment of the payment method
Return values
parameterdescription
added1 on success, 0 otherwise

/plans/payments/authorization

access: [READ]

This method returns an authorization code for the payment gateway.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/payments/authorization

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "secret": "7462ed9e2f2921dc9b5d3fb8099ddaca",
    "authorization": "645c8e2932324f777e962c8f35a26c74"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/payments/authorization?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <secret>7462ed9e2f2921dc9b5d3fb8099ddaca</secret>  
    <authorization>645c8e2932324f777e962c8f35a26c74</authorization>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/payments/authorization?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_secret=7462ed9e2f2921dc9b5d3fb8099ddaca
result_authorization=645c8e2932324f777e962c8f35a26c74

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/payments/authorization?format=plain

Query parameters

format = plain

Response

7462ed9e2f2921dc9b5d3fb8099ddaca
645c8e2932324f777e962c8f35a26c74
Return values
parameterdescription
authorizationpublic API key of the payment gateway
secretsecret key for the Strong Customer Authentication (SCA)

/plans/payments/default

access: [WRITE]

This method make a payment method the default one.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/payments/default?token=2606cd0ec28e6946cb9fcb3465660220

Query parameters

token = 2606cd0ec28e6946cb9fcb3465660220

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "default": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/payments/default?token=2606cd0ec28e6946cb9fcb3465660220&format=xml

Query parameters

 token = 2606cd0ec28e6946cb9fcb3465660220
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <default>1</default>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/payments/default?token=2606cd0ec28e6946cb9fcb3465660220&format=txt

Query parameters

 token = 2606cd0ec28e6946cb9fcb3465660220
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_default=1

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/payments/default?token=2606cd0ec28e6946cb9fcb3465660220&format=plain

Query parameters

 token = 2606cd0ec28e6946cb9fcb3465660220
format = plain

Response

default:1
Required parameters
parameterdescription
tokenSTRINGtoken that uniquely identifies the payment method
Return values
parameterdescription
default1 on success, 0 otherwise

/plans/payments/delete

access: [WRITE]

This method deletes a payment method.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/payments/delete?token=7470fe02e4e56e61187d92b738c8e963

Query parameters

token = 7470fe02e4e56e61187d92b738c8e963

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/payments/delete?token=7470fe02e4e56e61187d92b738c8e963&format=xml

Query parameters

 token = 7470fe02e4e56e61187d92b738c8e963
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/payments/delete?token=7470fe02e4e56e61187d92b738c8e963&format=txt

Query parameters

 token = 7470fe02e4e56e61187d92b738c8e963
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/payments/delete?token=7470fe02e4e56e61187d92b738c8e963&format=plain

Query parameters

 token = 7470fe02e4e56e61187d92b738c8e963
format = plain

Response

1
Required parameters
parameterdescription
tokenSTRINGtoken that uniquely identifies the payment method
Return values
parameterdescription
deleted1 on success, 0 otherwise

/plans/payments/paypals

/plans/payments/paypals/check

access: [WRITE]

This method checks a PayPal payment.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/payments/paypals/check?id=a8d4df678001f64a5ed15daeebb74702

Query parameters

id = a8d4df678001f64a5ed15daeebb74702

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "a8d4df678001f64a5ed15daeebb74702",
    "valid": 1,
    "total": 12.34,
    "currency": "EUR",
    "email": "this.is.your.email@pay.pal.com",
    "transaction_id": "d36a08c94338f75110"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/payments/paypals/check?id=a8d4df678001f64a5ed15daeebb74702&format=xml

Query parameters

    id = a8d4df678001f64a5ed15daeebb74702
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>a8d4df678001f64a5ed15daeebb74702</id>  
    <valid>1</valid>  
    <total>12.34</total>  
    <currency>EUR</currency>  
    <email>this.is.your.email@pay.pal.com</email>  
    <transaction_id>d36a08c94338f75110</transaction_id>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/payments/paypals/check?id=a8d4df678001f64a5ed15daeebb74702&format=txt

Query parameters

    id = a8d4df678001f64a5ed15daeebb74702
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=a8d4df678001f64a5ed15daeebb74702
result_valid=1
result_total=12.34
result_currency=EUR
result_email=this.is.your.email@pay.pal.com
result_transaction_id=d36a08c94338f75110

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/payments/paypals/check?id=a8d4df678001f64a5ed15daeebb74702&format=plain

Query parameters

    id = a8d4df678001f64a5ed15daeebb74702
format = plain

Response

a8d4df678001f64a5ed15daeebb74702
1
12.34
EUR
this.is.your.email@pay.pal.com
d36a08c94338f75110
Required parameters
parameterdescription
idSTRINGID of the PayPal payment to check
Return values
parameterdescription
currencycurrency of the payment, see https://developer.paypal.com/docs/api/reference/currency-codes/ for a list of payment codes
idecho back of the id input parameter
totalamount of the payment
valid1 if the PayPal payment is valid, 0 otherwise

/plans/subscriptions

/plans/subscriptions/delete

access: [WRITE]

This method cancels the plan (main) subscription associated with the current user.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/subscriptions/delete

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "canceled": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/subscriptions/delete?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <canceled>1</canceled>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/subscriptions/delete?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_canceled=1

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/subscriptions/delete?format=plain

Query parameters

format = plain

Response

1
Return values
parameterdescription
canceled1 on success (i.e., the subscription was canceled), 0 otherwise

/plans/subscriptions/estimate

access: [READ]

This method returns an estimate of the upcoming invoice for the logged user and, if available, information about discounts that will applied.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/subscriptions/estimate?start_datetime=2025-07-27+16%3A53%3A14

Query parameters

start_datetime = 2025-07-27 16:53:14

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "estimate_amount_due": 9,
    "estimate_invoice_date": "2025-07-27 16:53:14",
    "estimate_coupon": "",
    "estimate_balance": 0
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/subscriptions/estimate?start_datetime=2025-07-27+16%3A53%3A14&format=xml

Query parameters

start_datetime = 2025-07-27 16:53:14
        format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <estimate_amount_due>9</estimate_amount_due>  
    <estimate_invoice_date>2025-07-27 16:53:14</estimate_invoice_date>  
    <estimate_coupon></estimate_coupon>  
    <estimate_balance>0</estimate_balance>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/subscriptions/estimate?start_datetime=2025-07-27+16%3A53%3A14&format=txt

Query parameters

start_datetime = 2025-07-27 16:53:14
        format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_estimate_amount_due=9
result_estimate_invoice_date=2025-07-27 16:53:14
result_estimate_coupon=
result_estimate_balance=0

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/subscriptions/estimate?start_datetime=2025-07-27+16%3A53%3A14&format=plain

Query parameters

start_datetime = 2025-07-27 16:53:14
        format = plain

Response

9
2025-07-27 16:53:14

0
Required parameters
parameterdescription
idIDID of the plan to switch to in the estimate
periodSTRINGthe subscription billing period to be used in the estimate, it can be monthly or annually
Optional parameters
parameterdescription
couponSTRINGcoupon ID to be applied to calculate the estimate
start_datetimeDATE_TIMEthe estimate will be calculated as though the update was done at the specified date/time, if not specified, it will be equal to 3 minutes from the request
Return values
parameterdescription
estimate_amount_duethe amount of the estimate
estimate_balanceestimate user balance after the plan switch (negative means a credit, positive a debit)
estimate_couponcoupon code applied to the estimate, if available
estimate_invoice_datethe date/time at which the estimate was calculated

/plans/subscriptions/info

access: [READ]

This method returns information about the user's subscription.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/subscriptions/info

Response

{
  "status": "ACTIVE",
  "balance": 0,
  "createdAt": "2018-08-13T23:16:14+02:00",
  "updatedAt": "2018-08-13T23:16:14+02:00",
  "nextBillingDate": "2018-12-27T11:58:57+01:00",
  "firstBillingDate": "2018-12-27T11:58:57+01:00",
  "billingPeriodEndDate": "2018-12-27T11:58:57+01:00",
  "trialPeriod": 0,
  "neverExpires": 1
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/subscriptions/info?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ACTIVE</status>  
  <balance>0</balance>  
  <createdAt>2018-08-13T23:16:14+02:00</createdAt>  
  <updatedAt>2018-08-13T23:16:14+02:00</updatedAt>  
  <nextBillingDate>2018-12-27T11:58:57+01:00</nextBillingDate>  
  <firstBillingDate>2018-12-27T11:58:57+01:00</firstBillingDate>  
  <billingPeriodEndDate>2018-12-27T11:58:57+01:00</billingPeriodEndDate>  
  <trialPeriod>0</trialPeriod>  
  <neverExpires>1</neverExpires>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/subscriptions/info?format=txt

Query parameters

format = txt

Response

status=ACTIVE
balance=0
createdAt=2018-08-13T23:16:14+02:00
updatedAt=2018-08-13T23:16:14+02:00
nextBillingDate=2018-12-27T11:58:57+01:00
firstBillingDate=2018-12-27T11:58:57+01:00
billingPeriodEndDate=2018-12-27T11:58:57+01:00
trialPeriod=0
neverExpires=1

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/subscriptions/info?format=plain

Query parameters

format = plain

Response

ACTIVE
0
2018-08-13T23:16:14+02:00
2018-08-13T23:16:14+02:00
2018-12-27T11:58:57+01:00
2018-12-27T11:58:57+01:00
2018-12-27T11:58:57+01:00
0
1
Optional parameters
parameterdescription
idSTRINGNA
Return values
parameterdescription
balanceany remaining credit that will be used for future payments
billingPeriodEndDateend of the current period that the subscription has been invoiced for; at the end of this period, a new invoice will be created
createdAttime at which the subscription was created
firstBillingDatedate at which a new invoice will be generated for the subscription (for trialing subscriptions)
neverExpires0 if the subscription is scheduled to be canceled at the end of the current billing period, 1 otherwise
nextBillingDatedate at which a new invoice will be generated for the subscription
statussubscription status, see notes for details
trialPeriod1 if the subscription is in its trial period, 0 otherwise
updatedAttime at which the subscription was updated

/plans/subscriptions/set

access: [WRITE]

This method sets the primary subscription (plan) for the current user.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/subscriptions/set?paypal=0&nonce=2e16584772f72d29f425921195753c3a&type=buy&period=monthly&id=40b14ee093897490ad22f88efd224652&coupon=44D128E46EEA2FBE0DA2FABD566D979B

Query parameters

paypal = 0
 nonce = 2e16584772f72d29f425921195753c3a
  type = buy
period = monthly
    id = 40b14ee093897490ad22f88efd224652
coupon = 44D128E46EEA2FBE0DA2FABD566D979B

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "added": 1,
    "nonce": "7c5acc89606b02bc9cd273f639e14d4f27820a6d717588b0d5da73a84f4ee56e",
    "ref": "cf3db5ff643764d00422e4e5a50d6e8636ad4003da8dd5390e8d4b9a441d9833c8d6d3725f3be21a8c3315bfad1588f9"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/subscriptions/set?paypal=0&nonce=2e16584772f72d29f425921195753c3a&type=buy&period=monthly&id=40b14ee093897490ad22f88efd224652&coupon=44D128E46EEA2FBE0DA2FABD566D979B&format=xml

Query parameters

paypal = 0
 nonce = 2e16584772f72d29f425921195753c3a
  type = buy
period = monthly
    id = 40b14ee093897490ad22f88efd224652
coupon = 44D128E46EEA2FBE0DA2FABD566D979B
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <added>1</added>  
    <nonce>7c5acc89606b02bc9cd273f639e14d4f27820a6d717588b0d5da73a84f4ee56e</nonce>  
    <ref>cf3db5ff643764d00422e4e5a50d6e8636ad4003da8dd5390e8d4b9a441d9833c8d6d3725f3be21a8c3315bfad1588f9</ref>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/subscriptions/set?paypal=0&nonce=2e16584772f72d29f425921195753c3a&type=buy&period=monthly&id=40b14ee093897490ad22f88efd224652&coupon=44D128E46EEA2FBE0DA2FABD566D979B&format=txt

Query parameters

paypal = 0
 nonce = 2e16584772f72d29f425921195753c3a
  type = buy
period = monthly
    id = 40b14ee093897490ad22f88efd224652
coupon = 44D128E46EEA2FBE0DA2FABD566D979B
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_added=1
result_nonce=7c5acc89606b02bc9cd273f639e14d4f27820a6d717588b0d5da73a84f4ee56e
result_ref=cf3db5ff643764d00422e4e5a50d6e8636ad4003da8dd5390e8d4b9a441d9833c8d6d3725f3be21a8c3315bfad1588f9

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/subscriptions/set?paypal=0&nonce=2e16584772f72d29f425921195753c3a&type=buy&period=monthly&id=40b14ee093897490ad22f88efd224652&coupon=44D128E46EEA2FBE0DA2FABD566D979B&format=plain

Query parameters

paypal = 0
 nonce = 2e16584772f72d29f425921195753c3a
  type = buy
period = monthly
    id = 40b14ee093897490ad22f88efd224652
coupon = 44D128E46EEA2FBE0DA2FABD566D979B
format = plain

Response

1
7c5acc89606b02bc9cd273f639e14d4f27820a6d717588b0d5da73a84f4ee56e
cf3db5ff643764d00422e4e5a50d6e8636ad4003da8dd5390e8d4b9a441d9833c8d6d3725f3be21a8c3315bfad1588f9
Required parameters
parameterdescription
idIDID of the plan to subscribe to
periodSTRINGthe subscription billing period, it can be monthly or annually
typeSTRINGit can be try if you want to activate a trial period or buy if you want to buy a subscriptionn
Optional parameters
parameterdescription
couponSTRINGcoupon ID to be applied to the subscription
nonceSTRINGa unique disposable identifier used to identify the payment methods, this parameter is mandatory if a coupon code with 100% discount is not specified
paypalBOOLEAN1 if PayPal was used to pay the subscription, 0 otherwise
Return values
parameterdescription
added1 if the subscription has been activated, 0 otherwise
nonceunique identifier to be used where requested
refunique reference for the transaction to be used where requested

/plans/suggest

access: [READ]

This method suggests a plan suitable for the number of events generated by the logged user.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/suggest

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "estimated_events_per_month": 350000,
    "suggested_plan": {
      "id": "e865d8bcfb81bc3bdbcd673604276e9c",
      "name": "business",
      "annually_cost": 135,
      "monthly_cost": 169,
      "events_per_month": 500000,
      "tracking_links": 100000,
      "stats_permanency_days": 730,
      "max_users": 30,
      "max_brands": 70,
      "has_smart_balancer": 1,
      "has_split_testing": 1,
      "has_smart_redirector": 1,
      "max_qrcode_templates": 100,
      "max_projects": "",
      "has_conversions": 1,
      "has_timed_urls": 1,
      "force_brand_on_ctas": 0,
      "has_watchdog_ping": 1,
      "has_watchdog_advanced": 1,
      "number_of_ctas": "",
      "max_banners": "",
      "custom_domains": 30,
      "email_support": 1,
      "priority_email_support": 1,
      "has_security_monitor": 1,
      "has_cfm": 1,
      "has_custom_aliases": 1,
      "has_masking": 1,
      "has_jotbar": 1,
      "has_custom_logo_in_reports": 1,
      "has_custom_css_cta": 1,
      "has_setup_assistance_and_training": 0,
      "has_custom_invoicing": 0,
      "has_enterprise_sla": 0,
      "has_customizations_and_integrations": 0,
      "has_digital_marketing_advice": 0,
      "has_minipages": 1,
      "has_deeplinks": 1,
      "has_easydeeplinks": 1,
      "has_preview": 1,
      "public_name": "Business",
      "has_utm_builder": 1,
      "max_utm_templates": 30,
      "has_remarketing": "",
      "has_whatsapp": 1,
      "has_instaurl": 0,
      "has_selfdestruction": 0,
      "is_monthly": 1,
      "status": "green",
      "trial_left_days": 30,
      "events": "",
      "is_monitored": 1,
      "email_sent": 0,
      "subscription_status": "ACTIVE",
      "subscription_creation": "2018-08-13T23:16:14+02:00",
      "subscription_next_billing_date": "2018-12-27T11:58:57+01:00",
      "subscription_billing_end_date": "2018-12-27T11:58:57+01:00",
      "subscription_never_expires": 1,
      "subscription_trial_period": 0,
      "subscription_first_billing_date": "2018-12-27T11:58:57+01:00",
      "subscription_balance": 0,
      "max_gdpr_templates": 10
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/suggest?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <estimated_events_per_month>350000</estimated_events_per_month>  
    <suggested_plan>
      <id>e865d8bcfb81bc3bdbcd673604276e9c</id>  
      <name>business</name>  
      <annually_cost>135</annually_cost>  
      <monthly_cost>169</monthly_cost>  
      <events_per_month>500000</events_per_month>  
      <tracking_links>100000</tracking_links>  
      <stats_permanency_days>730</stats_permanency_days>  
      <max_users>30</max_users>  
      <max_brands>70</max_brands>  
      <has_smart_balancer>1</has_smart_balancer>  
      <has_split_testing>1</has_split_testing>  
      <has_smart_redirector>1</has_smart_redirector>  
      <max_qrcode_templates>100</max_qrcode_templates>  
      <max_projects></max_projects>  
      <has_conversions>1</has_conversions>  
      <has_timed_urls>1</has_timed_urls>  
      <force_brand_on_ctas>0</force_brand_on_ctas>  
      <has_watchdog_ping>1</has_watchdog_ping>  
      <has_watchdog_advanced>1</has_watchdog_advanced>  
      <number_of_ctas></number_of_ctas>  
      <max_banners></max_banners>  
      <custom_domains>30</custom_domains>  
      <email_support>1</email_support>  
      <priority_email_support>1</priority_email_support>  
      <has_security_monitor>1</has_security_monitor>  
      <has_cfm>1</has_cfm>  
      <has_custom_aliases>1</has_custom_aliases>  
      <has_masking>1</has_masking>  
      <has_jotbar>1</has_jotbar>  
      <has_custom_logo_in_reports>1</has_custom_logo_in_reports>  
      <has_custom_css_cta>1</has_custom_css_cta>  
      <has_setup_assistance_and_training>0</has_setup_assistance_and_training>  
      <has_custom_invoicing>0</has_custom_invoicing>  
      <has_enterprise_sla>0</has_enterprise_sla>  
      <has_customizations_and_integrations>0</has_customizations_and_integrations>  
      <has_digital_marketing_advice>0</has_digital_marketing_advice>  
      <has_minipages>1</has_minipages>  
      <has_deeplinks>1</has_deeplinks>  
      <has_easydeeplinks>1</has_easydeeplinks>  
      <has_preview>1</has_preview>  
      <public_name>Business</public_name>  
      <has_utm_builder>1</has_utm_builder>  
      <max_utm_templates>30</max_utm_templates>  
      <has_remarketing></has_remarketing>  
      <has_whatsapp>1</has_whatsapp>  
      <has_instaurl>0</has_instaurl>  
      <has_selfdestruction>0</has_selfdestruction>  
      <is_monthly>1</is_monthly>  
      <status>green</status>  
      <trial_left_days>30</trial_left_days>  
      <events></events>  
      <is_monitored>1</is_monitored>  
      <email_sent>0</email_sent>  
      <subscription_status>ACTIVE</subscription_status>  
      <subscription_creation>2018-08-13T23:16:14+02:00</subscription_creation>  
      <subscription_next_billing_date>2018-12-27T11:58:57+01:00</subscription_next_billing_date>  
      <subscription_billing_end_date>2018-12-27T11:58:57+01:00</subscription_billing_end_date>  
      <subscription_never_expires>1</subscription_never_expires>  
      <subscription_trial_period>0</subscription_trial_period>  
      <subscription_first_billing_date>2018-12-27T11:58:57+01:00</subscription_first_billing_date>  
      <subscription_balance>0</subscription_balance>  
      <max_gdpr_templates>10</max_gdpr_templates>  
    </suggested_plan>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/suggest?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_estimated_events_per_month=350000
result_suggested_plan_id=e865d8bcfb81bc3bdbcd673604276e9c
result_suggested_plan_name=business
result_suggested_plan_annually_cost=135
result_suggested_plan_monthly_cost=169
result_suggested_plan_events_per_month=500000
result_suggested_plan_tracking_links=100000
result_suggested_plan_stats_permanency_days=730
result_suggested_plan_max_users=30
result_suggested_plan_max_brands=70
result_suggested_plan_has_smart_balancer=1
result_suggested_plan_has_split_testing=1
result_suggested_plan_has_smart_redirector=1
result_suggested_plan_max_qrcode_templates=100
result_suggested_plan_max_projects=
result_suggested_plan_has_conversions=1
result_suggested_plan_has_timed_urls=1
result_suggested_plan_force_brand_on_ctas=0
result_suggested_plan_has_watchdog_ping=1
result_suggested_plan_has_watchdog_advanced=1
result_suggested_plan_number_of_ctas=
result_suggested_plan_max_banners=
result_suggested_plan_custom_domains=30
result_suggested_plan_email_support=1
result_suggested_plan_priority_email_support=1
result_suggested_plan_has_security_monitor=1
result_suggested_plan_has_cfm=1
result_suggested_plan_has_custom_aliases=1
result_suggested_plan_has_masking=1
result_suggested_plan_has_jotbar=1
result_suggested_plan_has_custom_logo_in_reports=1
result_suggested_plan_has_custom_css_cta=1
result_suggested_plan_has_setup_assistance_and_training=0
result_suggested_plan_has_custom_invoicing=0
result_suggested_plan_has_enterprise_sla=0
result_suggested_plan_has_customizations_and_integrations=0
result_suggested_plan_has_digital_marketing_advice=0
result_suggested_plan_has_minipages=1
result_suggested_plan_has_deeplinks=1
result_suggested_plan_has_easydeeplinks=1
result_suggested_plan_has_preview=1
result_suggested_plan_public_name=Business
result_suggested_plan_has_utm_builder=1
result_suggested_plan_max_utm_templates=30
result_suggested_plan_has_remarketing=
result_suggested_plan_has_whatsapp=1
result_suggested_plan_has_instaurl=0
result_suggested_plan_has_selfdestruction=0
result_suggested_plan_is_monthly=1
result_suggested_plan_status=green
result_suggested_plan_trial_left_days=30
result_suggested_plan_events=
result_suggested_plan_is_monitored=1
result_suggested_plan_email_sent=0
result_suggested_plan_subscription_status=ACTIVE
result_suggested_plan_subscription_creation=2018-08-13T23:16:14+02:00
result_suggested_plan_subscription_next_billing_date=2018-12-27T11:58:57+01:00
result_suggested_plan_subscription_billing_end_date=2018-12-27T11:58:57+01:00
result_suggested_plan_subscription_never_expires=1
result_suggested_plan_subscription_trial_period=0
result_suggested_plan_subscription_first_billing_date=2018-12-27T11:58:57+01:00
result_suggested_plan_subscription_balance=0
result_suggested_plan_max_gdpr_templates=10

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/suggest?format=plain

Query parameters

format = plain

Response

350000
e865d8bcfb81bc3bdbcd673604276e9c
business
135
169
500000
100000
730
30
70
1
1
1
100

1
1
0
1
1


30
1
1
1
1
1
1
1
1
1
0
0
0
0
0
1
1
1
1
Business
1
30

1
0
0
1
green
30

1
0
ACTIVE
2018-08-13T23:16:14+02:00
2018-12-27T11:58:57+01:00
2018-12-27T11:58:57+01:00
1
0
2018-12-27T11:58:57+01:00
0
10
Return values
parameterdescription
estimated_events_per_monthestimated events per month
suggested_plan[OPTIONAL] array containing info for the suggested plan, it is returned only if this method can find a suitable plan for the user

/plans/update

access: [READ]

This method updates information about the user's plan. It should be called after a change of the user plan.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/update

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "new_plan": "Basic",
    "old_plan": "Basic"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/update?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <new_plan>Basic</new_plan>  
    <old_plan>Basic</old_plan>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/update?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_new_plan=Basic
result_old_plan=Basic

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/update?format=plain

Query parameters

format = plain

Response

Basic
Basic
Return values
parameterdescription
new_planthe new plan name for the user, it can be the equal to old_plan if no change takes place
old_planthe old plan name for the user

/plans/vats

/plans/vats/property

access: [READ]

This method returns the list of available VAT treatments.

Example 1 (json)

Request

https://joturl.com/a/i1/plans/vats/property

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": [
    "ITALY_PRIVATE",
    "ITALY_BUSINESS",
    "INTRA_EU_PRIVATE",
    "INTRA_EU_BUSINESS",
    "EXTRA_EU_PRIVATE",
    "EXTRA_EU_BUSINESS"
  ]
}

Example 2 (xml)

Request

https://joturl.com/a/i1/plans/vats/property?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <i0>ITALY_PRIVATE</i0>  
    <i1>ITALY_BUSINESS</i1>  
    <i2>INTRA_EU_PRIVATE</i2>  
    <i3>INTRA_EU_BUSINESS</i3>  
    <i4>EXTRA_EU_PRIVATE</i4>  
    <i5>EXTRA_EU_BUSINESS</i5>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/plans/vats/property?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_0=ITALY_PRIVATE
result_1=ITALY_BUSINESS
result_2=INTRA_EU_PRIVATE
result_3=INTRA_EU_BUSINESS
result_4=EXTRA_EU_PRIVATE
result_5=EXTRA_EU_BUSINESS

Example 4 (plain)

Request

https://joturl.com/a/i1/plans/vats/property?format=plain

Query parameters

format = plain

Response

ITALY_PRIVATE
ITALY_BUSINESS
INTRA_EU_PRIVATE
INTRA_EU_BUSINESS
EXTRA_EU_PRIVATE
EXTRA_EU_BUSINESS
Return values
parameterdescription
[ARRAY]array of available VAT treatment

/projects

/projects/add

access: [WRITE]

Add a project with a specified name.

Example 1 (json)

Request

https://joturl.com/a/i1/projects/add?name=name+for+the+project+name&client=this+is+a+sample+note&has_utm_parameters=1

Query parameters

              name = name for the project name
            client = this is a sample note
has_utm_parameters = 1

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "84c1f701157a89749326693dab40f5ff",
    "name": "name for the project name",
    "client": "this is a sample note",
    "has_utm_parameters": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/projects/add?name=name+for+the+project+name&client=this+is+a+sample+note&has_utm_parameters=1&format=xml

Query parameters

              name = name for the project name
            client = this is a sample note
has_utm_parameters = 1
            format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>84c1f701157a89749326693dab40f5ff</id>  
    <name>name for the project name</name>  
    <client>this is a sample note</client>  
    <has_utm_parameters>1</has_utm_parameters>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/projects/add?name=name+for+the+project+name&client=this+is+a+sample+note&has_utm_parameters=1&format=txt

Query parameters

              name = name for the project name
            client = this is a sample note
has_utm_parameters = 1
            format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=84c1f701157a89749326693dab40f5ff
result_name=name for the project name
result_client=this is a sample note
result_has_utm_parameters=1

Example 4 (plain)

Request

https://joturl.com/a/i1/projects/add?name=name+for+the+project+name&client=this+is+a+sample+note&has_utm_parameters=1&format=plain

Query parameters

              name = name for the project name
            client = this is a sample note
has_utm_parameters = 1
            format = plain

Response

84c1f701157a89749326693dab40f5ff
name for the project name
this is a sample note
1
Required parameters
parameterdescriptionmax length
nameSTRINGproject name255
Optional parameters
parameterdescriptionmax length
clientSTRINGname of the client to whom the project is dedicated and/or the notes for the project255
has_utm_parametersBOOLEAN1 to enable the UTM view, 0 otherwise
Return values
parameterdescription
clientecho back of the client parameter
idID of the project
nameecho back of the name parameter

/projects/count

access: [READ]

This method returns the number of user's projects.

Example 1 (json)

Request

https://joturl.com/a/i1/projects/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 75
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/projects/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>75</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/projects/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=75

Example 4 (plain)

Request

https://joturl.com/a/i1/projects/count?format=plain

Query parameters

format = plain

Response

75
Optional parameters
parameterdescription
accountSTRINGif 1 this methods returns the total number of projects (other parameters are ignored)
end_dateSTRINGfilter projects created up to this date (inclusive)
searchSTRINGfilter projects by searching them
start_dateSTRINGfilter projects created from this date (inclusive)
with_alertsBOOLEANfilter projects with security alerts
Return values
parameterdescription
countnumber of projects

/projects/defaults

/projects/defaults/get

access: [READ]

Get a default setting for the project.

Example 1 (json)

Request

https://joturl.com/a/i1/projects/defaults/get?project_id=751157f2e93c52fe24a5b618e48853b1&setting=default_tl

Query parameters

project_id = 751157f2e93c52fe24a5b618e48853b1
   setting = default_tl

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "value": "661806daf9c60060075fefad24e96fda"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/projects/defaults/get?project_id=751157f2e93c52fe24a5b618e48853b1&setting=default_tl&format=xml

Query parameters

project_id = 751157f2e93c52fe24a5b618e48853b1
   setting = default_tl
    format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <value>661806daf9c60060075fefad24e96fda</value>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/projects/defaults/get?project_id=751157f2e93c52fe24a5b618e48853b1&setting=default_tl&format=txt

Query parameters

project_id = 751157f2e93c52fe24a5b618e48853b1
   setting = default_tl
    format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_value=661806daf9c60060075fefad24e96fda

Example 4 (plain)

Request

https://joturl.com/a/i1/projects/defaults/get?project_id=751157f2e93c52fe24a5b618e48853b1&setting=default_tl&format=plain

Query parameters

project_id = 751157f2e93c52fe24a5b618e48853b1
   setting = default_tl
    format = plain

Response

661806daf9c60060075fefad24e96fda
Required parameters
parameterdescriptionmax length
project_idIDID of the project
settingSTRINGsetting to obtain, see i1/projects/defaults/set for details50
Return values
parameterdescription
valuethe value of the required setting

/projects/defaults/set

access: [WRITE]

Set/unset a default setting for the project.

Example 1 (json)

Request

https://joturl.com/a/i1/projects/defaults/set?project_id=fda8901d15967b59f64362bbe01a8b2e&setting=default_tl&value=c05b7adce510cae2ca91cdac940dd266

Query parameters

project_id = fda8901d15967b59f64362bbe01a8b2e
   setting = default_tl
     value = c05b7adce510cae2ca91cdac940dd266

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "set": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/projects/defaults/set?project_id=fda8901d15967b59f64362bbe01a8b2e&setting=default_tl&value=c05b7adce510cae2ca91cdac940dd266&format=xml

Query parameters

project_id = fda8901d15967b59f64362bbe01a8b2e
   setting = default_tl
     value = c05b7adce510cae2ca91cdac940dd266
    format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <set>1</set>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/projects/defaults/set?project_id=fda8901d15967b59f64362bbe01a8b2e&setting=default_tl&value=c05b7adce510cae2ca91cdac940dd266&format=txt

Query parameters

project_id = fda8901d15967b59f64362bbe01a8b2e
   setting = default_tl
     value = c05b7adce510cae2ca91cdac940dd266
    format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_set=1

Example 4 (plain)

Request

https://joturl.com/a/i1/projects/defaults/set?project_id=fda8901d15967b59f64362bbe01a8b2e&setting=default_tl&value=c05b7adce510cae2ca91cdac940dd266&format=plain

Query parameters

project_id = fda8901d15967b59f64362bbe01a8b2e
   setting = default_tl
     value = c05b7adce510cae2ca91cdac940dd266
    format = plain

Response

1
Required parameters
parameterdescriptionmax length
project_idIDID of the project
settingSTRINGsetting to be set/unset, settings available: default_tl, default_domain50
Optional parameters
parameterdescriptionmax length
valueIDthe value to be setted, empty to unset50
Return values
parameterdescription
set1 on set, 0 otherwise

/projects/delete

access: [WRITE]

This method deletes a set of projects using the ids. Return 1 if the operation succeeds or 0 otherwise.

Example 1 (json)

Request

https://joturl.com/a/i1/projects/delete?ids=6a5eb29bbbf8997ebc1c06351652d745,b54daf1b0028f1c892d8e3a56261d078,d21101504fe6d77dbe1419d37c2e2838

Query parameters

ids = 6a5eb29bbbf8997ebc1c06351652d745,b54daf1b0028f1c892d8e3a56261d078,d21101504fe6d77dbe1419d37c2e2838

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 3
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/projects/delete?ids=6a5eb29bbbf8997ebc1c06351652d745,b54daf1b0028f1c892d8e3a56261d078,d21101504fe6d77dbe1419d37c2e2838&format=xml

Query parameters

   ids = 6a5eb29bbbf8997ebc1c06351652d745,b54daf1b0028f1c892d8e3a56261d078,d21101504fe6d77dbe1419d37c2e2838
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>3</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/projects/delete?ids=6a5eb29bbbf8997ebc1c06351652d745,b54daf1b0028f1c892d8e3a56261d078,d21101504fe6d77dbe1419d37c2e2838&format=txt

Query parameters

   ids = 6a5eb29bbbf8997ebc1c06351652d745,b54daf1b0028f1c892d8e3a56261d078,d21101504fe6d77dbe1419d37c2e2838
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=3

Example 4 (plain)

Request

https://joturl.com/a/i1/projects/delete?ids=6a5eb29bbbf8997ebc1c06351652d745,b54daf1b0028f1c892d8e3a56261d078,d21101504fe6d77dbe1419d37c2e2838&format=plain

Query parameters

   ids = 6a5eb29bbbf8997ebc1c06351652d745,b54daf1b0028f1c892d8e3a56261d078,d21101504fe6d77dbe1419d37c2e2838
format = plain

Response

3

Example 5 (json)

Request

https://joturl.com/a/i1/projects/delete?ids=8049bed24bcafa447745f016d67c8580,cc26501c8302d384cf23cd11dd4e849a,3a6b335da6961cafd716065dec61c9e7

Query parameters

ids = 8049bed24bcafa447745f016d67c8580,cc26501c8302d384cf23cd11dd4e849a,3a6b335da6961cafd716065dec61c9e7

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "ids": [
      "cc26501c8302d384cf23cd11dd4e849a",
      "3a6b335da6961cafd716065dec61c9e7"
    ],
    "deleted": 1
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/projects/delete?ids=8049bed24bcafa447745f016d67c8580,cc26501c8302d384cf23cd11dd4e849a,3a6b335da6961cafd716065dec61c9e7&format=xml

Query parameters

   ids = 8049bed24bcafa447745f016d67c8580,cc26501c8302d384cf23cd11dd4e849a,3a6b335da6961cafd716065dec61c9e7
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <ids>
      <i0>cc26501c8302d384cf23cd11dd4e849a</i0>  
      <i1>3a6b335da6961cafd716065dec61c9e7</i1>  
    </ids>  
    <deleted>1</deleted>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/projects/delete?ids=8049bed24bcafa447745f016d67c8580,cc26501c8302d384cf23cd11dd4e849a,3a6b335da6961cafd716065dec61c9e7&format=txt

Query parameters

   ids = 8049bed24bcafa447745f016d67c8580,cc26501c8302d384cf23cd11dd4e849a,3a6b335da6961cafd716065dec61c9e7
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_ids_0=cc26501c8302d384cf23cd11dd4e849a
result_ids_1=3a6b335da6961cafd716065dec61c9e7
result_deleted=1

Example 8 (plain)

Request

https://joturl.com/a/i1/projects/delete?ids=8049bed24bcafa447745f016d67c8580,cc26501c8302d384cf23cd11dd4e849a,3a6b335da6961cafd716065dec61c9e7&format=plain

Query parameters

   ids = 8049bed24bcafa447745f016d67c8580,cc26501c8302d384cf23cd11dd4e849a,3a6b335da6961cafd716065dec61c9e7
format = plain

Response

cc26501c8302d384cf23cd11dd4e849a
3a6b335da6961cafd716065dec61c9e7
1
Required parameters
parameterdescription
idsARRAY_OF_IDScomma separated list of project IDs to be deleted
Return values
parameterdescription
deletednumber of deleted projects
ids[OPTIONAL] list of project IDs whose delete has failed, this parameter is returned only when at least one delete error has occurred

/projects/edit

access: [WRITE]

Edit a project data for the user logged in.

Example 1 (json)

Request

https://joturl.com/a/i1/projects/edit?id=f286a9725014d703a3760f1edfe59268&name=new+name+for+the+project&client=new+notes+for+the+project

Query parameters

    id = f286a9725014d703a3760f1edfe59268
  name = new name for the project
client = new notes for the project

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "f286a9725014d703a3760f1edfe59268",
    "name": "new name for the project",
    "client": "new notes for the project"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/projects/edit?id=f286a9725014d703a3760f1edfe59268&name=new+name+for+the+project&client=new+notes+for+the+project&format=xml

Query parameters

    id = f286a9725014d703a3760f1edfe59268
  name = new name for the project
client = new notes for the project
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>f286a9725014d703a3760f1edfe59268</id>  
    <name>new name for the project</name>  
    <client>new notes for the project</client>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/projects/edit?id=f286a9725014d703a3760f1edfe59268&name=new+name+for+the+project&client=new+notes+for+the+project&format=txt

Query parameters

    id = f286a9725014d703a3760f1edfe59268
  name = new name for the project
client = new notes for the project
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=f286a9725014d703a3760f1edfe59268
result_name=new name for the project
result_client=new notes for the project

Example 4 (plain)

Request

https://joturl.com/a/i1/projects/edit?id=f286a9725014d703a3760f1edfe59268&name=new+name+for+the+project&client=new+notes+for+the+project&format=plain

Query parameters

    id = f286a9725014d703a3760f1edfe59268
  name = new name for the project
client = new notes for the project
format = plain

Response

f286a9725014d703a3760f1edfe59268
new name for the project
new notes for the project
Required parameters
parameterdescription
idIDID of the project
Optional parameters
parameterdescriptionmax length
clientSTRINGnew name of the client to whom the project is dedicated and/or new notes for the project255
has_utm_parametersBOOLEAN1 to enable the UTM view, 0 otherwise
nameSTRINGnew name for the project255
Return values
parameterdescription
client[OPTIONAL] echo back of the name of the client to whom the project is dedicated and/or the notes for the project
has_utm_parameters[OPTIONAL] echo back of has_utm_parameters parameter
idID of the project
name[OPTIONAL] echo back of the name of the project

/projects/info

access: [READ]

This method returns information on a project, the returned information depends on input parameter fields.

Example 1 (json)

Request

https://joturl.com/a/i1/projects/info?id=7c28c6a3962205697ba0bc2e2b5cc6d3&fields=name,id

Query parameters

    id = 7c28c6a3962205697ba0bc2e2b5cc6d3
fields = name,id

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "name": "project 1",
    "id": "7c28c6a3962205697ba0bc2e2b5cc6d3"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/projects/info?id=7c28c6a3962205697ba0bc2e2b5cc6d3&fields=name,id&format=xml

Query parameters

    id = 7c28c6a3962205697ba0bc2e2b5cc6d3
fields = name,id
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <name>project 1</name>  
    <id>7c28c6a3962205697ba0bc2e2b5cc6d3</id>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/projects/info?id=7c28c6a3962205697ba0bc2e2b5cc6d3&fields=name,id&format=txt

Query parameters

    id = 7c28c6a3962205697ba0bc2e2b5cc6d3
fields = name,id
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_name=project 1
result_id=7c28c6a3962205697ba0bc2e2b5cc6d3

Example 4 (plain)

Request

https://joturl.com/a/i1/projects/info?id=7c28c6a3962205697ba0bc2e2b5cc6d3&fields=name,id&format=plain

Query parameters

    id = 7c28c6a3962205697ba0bc2e2b5cc6d3
fields = name,id
format = plain

Response

project 1
7c28c6a3962205697ba0bc2e2b5cc6d3
Required parameters
parameterdescription
fieldsARRAYcomma separated list of fields to return, available fields: name, client, id, creation, urls_count, conversions_visits, remarketings_visits, ctas_visits, qrcodes_visits, unique_visits, visits, has_utm_parameters, is_default
idIDID of the project
Return values
parameterdescription
client[OPTIONAL] name of the client to whom the project is dedicated and/or the notes for the project
conversions_visits[OPTIONAL] number of conversions clicks on tracking links in the project
creation[OPTIONAL] date of creation of the project
ctas_visits[OPTIONAL] number of CTA clicks on tracking links in the project
has_utm_parameters[OPTIONAL] 1 if the project has UTM view enabled, 0 otherwise
id[OPTIONAL] ID of the project
is_default[OPTIONAL] 1 if it is the default project, 0 otherwise
name[OPTIONAL] name of the project
qrcodes_visits[OPTIONAL] number of visits on tracking links in the project coming from QR codes
remarketings_visits[OPTIONAL] number of remarketings clicks on tracking links in the project
unique_visits[OPTIONAL] number of unique visits on tracking links in the project
urls_count[OPTIONAL] number of tracking links in the project
visits[OPTIONAL] number of visits on tracking links in the project

/projects/jotbars

/projects/jotbars/edit

access: [WRITE]

Set a jotbar option for a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/projects/jotbars/edit?id=5a0019b9164e726b942b742e138f9918&logo=https%3A%2F%2Fjoturl.com%2Flogo.svg&logo_url=https%3A%2F%2Fjoturl.com%2F&template=right&template_size=big&languages=en,it&default_language=&user_default_language=en&info=%7B%22en%22%3A%7B%22page_title%22%3A%22English+page+title%22,%22description_title%22%3Anull,%22description%22%3A%22%3Cp%3E%5BEN%5D+HTML+description%3C%5C%2Fp%3E%22,%22questions_title%22%3Anull,%22questions%22%3A%22%3Cp%3E%5BEN%5D+HTML+questions%3C%5C%2Fp%3E%22%7D,%22it%22%3A%7B%22page_title%22%3A%22Titolo+pagina+in+italiano%22,%22description_title%22%3Anull,%22description%22%3A%22%3Cp%3E%5BIT%5D+HTML+description%3C%5C%2Fp%3E%22,%22questions_title%22%3Anull,%22questions%22%3A%22%3Cp%3E%5BIT%5D+HTML+questions%3C%5C%2Fp%3E%22%7D%7D

Query parameters

                   id = 5a0019b9164e726b942b742e138f9918
                 logo = https://joturl.com/logo.svg
             logo_url = https://joturl.com/
             template = right
        template_size = big
            languages = en,it
     default_language = 
user_default_language = en
                 info = {"en":{"page_title":"English page title","description_title":null,"description":"<p>[EN] HTML description<\/p>","questions_title":null,"questions":"<p>[EN] HTML questions<\/p>"},"it":{"page_title":"Titolo pagina in italiano","description_title":null,"description":"<p>[IT] HTML description<\/p>","questions_title":null,"questions":"<p>[IT] HTML questions<\/p>"}}

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "updated": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/projects/jotbars/edit?id=5a0019b9164e726b942b742e138f9918&logo=https%3A%2F%2Fjoturl.com%2Flogo.svg&logo_url=https%3A%2F%2Fjoturl.com%2F&template=right&template_size=big&languages=en,it&default_language=&user_default_language=en&info=%7B%22en%22%3A%7B%22page_title%22%3A%22English+page+title%22,%22description_title%22%3Anull,%22description%22%3A%22%3Cp%3E%5BEN%5D+HTML+description%3C%5C%2Fp%3E%22,%22questions_title%22%3Anull,%22questions%22%3A%22%3Cp%3E%5BEN%5D+HTML+questions%3C%5C%2Fp%3E%22%7D,%22it%22%3A%7B%22page_title%22%3A%22Titolo+pagina+in+italiano%22,%22description_title%22%3Anull,%22description%22%3A%22%3Cp%3E%5BIT%5D+HTML+description%3C%5C%2Fp%3E%22,%22questions_title%22%3Anull,%22questions%22%3A%22%3Cp%3E%5BIT%5D+HTML+questions%3C%5C%2Fp%3E%22%7D%7D&format=xml

Query parameters

                   id = 5a0019b9164e726b942b742e138f9918
                 logo = https://joturl.com/logo.svg
             logo_url = https://joturl.com/
             template = right
        template_size = big
            languages = en,it
     default_language = 
user_default_language = en
                 info = {"en":{"page_title":"English page title","description_title":null,"description":"<p>[EN] HTML description<\/p>","questions_title":null,"questions":"<p>[EN] HTML questions<\/p>"},"it":{"page_title":"Titolo pagina in italiano","description_title":null,"description":"<p>[IT] HTML description<\/p>","questions_title":null,"questions":"<p>[IT] HTML questions<\/p>"}}
               format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <updated>1</updated>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/projects/jotbars/edit?id=5a0019b9164e726b942b742e138f9918&logo=https%3A%2F%2Fjoturl.com%2Flogo.svg&logo_url=https%3A%2F%2Fjoturl.com%2F&template=right&template_size=big&languages=en,it&default_language=&user_default_language=en&info=%7B%22en%22%3A%7B%22page_title%22%3A%22English+page+title%22,%22description_title%22%3Anull,%22description%22%3A%22%3Cp%3E%5BEN%5D+HTML+description%3C%5C%2Fp%3E%22,%22questions_title%22%3Anull,%22questions%22%3A%22%3Cp%3E%5BEN%5D+HTML+questions%3C%5C%2Fp%3E%22%7D,%22it%22%3A%7B%22page_title%22%3A%22Titolo+pagina+in+italiano%22,%22description_title%22%3Anull,%22description%22%3A%22%3Cp%3E%5BIT%5D+HTML+description%3C%5C%2Fp%3E%22,%22questions_title%22%3Anull,%22questions%22%3A%22%3Cp%3E%5BIT%5D+HTML+questions%3C%5C%2Fp%3E%22%7D%7D&format=txt

Query parameters

                   id = 5a0019b9164e726b942b742e138f9918
                 logo = https://joturl.com/logo.svg
             logo_url = https://joturl.com/
             template = right
        template_size = big
            languages = en,it
     default_language = 
user_default_language = en
                 info = {"en":{"page_title":"English page title","description_title":null,"description":"<p>[EN] HTML description<\/p>","questions_title":null,"questions":"<p>[EN] HTML questions<\/p>"},"it":{"page_title":"Titolo pagina in italiano","description_title":null,"description":"<p>[IT] HTML description<\/p>","questions_title":null,"questions":"<p>[IT] HTML questions<\/p>"}}
               format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_updated=1

Example 4 (plain)

Request

https://joturl.com/a/i1/projects/jotbars/edit?id=5a0019b9164e726b942b742e138f9918&logo=https%3A%2F%2Fjoturl.com%2Flogo.svg&logo_url=https%3A%2F%2Fjoturl.com%2F&template=right&template_size=big&languages=en,it&default_language=&user_default_language=en&info=%7B%22en%22%3A%7B%22page_title%22%3A%22English+page+title%22,%22description_title%22%3Anull,%22description%22%3A%22%3Cp%3E%5BEN%5D+HTML+description%3C%5C%2Fp%3E%22,%22questions_title%22%3Anull,%22questions%22%3A%22%3Cp%3E%5BEN%5D+HTML+questions%3C%5C%2Fp%3E%22%7D,%22it%22%3A%7B%22page_title%22%3A%22Titolo+pagina+in+italiano%22,%22description_title%22%3Anull,%22description%22%3A%22%3Cp%3E%5BIT%5D+HTML+description%3C%5C%2Fp%3E%22,%22questions_title%22%3Anull,%22questions%22%3A%22%3Cp%3E%5BIT%5D+HTML+questions%3C%5C%2Fp%3E%22%7D%7D&format=plain

Query parameters

                   id = 5a0019b9164e726b942b742e138f9918
                 logo = https://joturl.com/logo.svg
             logo_url = https://joturl.com/
             template = right
        template_size = big
            languages = en,it
     default_language = 
user_default_language = en
                 info = {"en":{"page_title":"English page title","description_title":null,"description":"<p>[EN] HTML description<\/p>","questions_title":null,"questions":"<p>[EN] HTML questions<\/p>"},"it":{"page_title":"Titolo pagina in italiano","description_title":null,"description":"<p>[IT] HTML description<\/p>","questions_title":null,"questions":"<p>[IT] HTML questions<\/p>"}}
               format = plain

Response

1
Required parameters
parameterdescription
idIDID of the project
languagesARRAYcomma-separated list of the languages selected for the jotbar, the jotbar will be shown to the user in the language the user has chosen in his/hers browser, if the user has an unsupported language the default language will be used (i.e., default_language if not empty, user_default_language otherwise)
Optional parameters
parameterdescription
default_languageSTRINGdefault language within languages, empty or null to inherit the configuration from the account-level settings
infoJSONJSON containing page_title, description_title, description, questions_title, questions for each language in languages, see i1/projects/jotbars/info for details on info
logoSTRINGit can be:
Return values
parameterdescription
updated1 on success, 0 otherwise

/projects/jotbars/info

access: [READ]

Get jotbar information for the project.

Example 1 (json)

Request

https://joturl.com/a/i1/projects/jotbars/info?id=f3b29067262c1168646f284423d6017e

Query parameters

id = f3b29067262c1168646f284423d6017e

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "logo": "https:\/\/joturl.com\/logo.svg",
    "logo_url": "https:\/\/joturl.com\/",
    "template": "right",
    "template_size": "big",
    "show_feedback": null,
    "languages": "en,it",
    "default_language": "",
    "user_default_language": "en",
    "info": {
      "en": {
        "page_title": "English page title",
        "description_title": null,
        "description": "<p>[EN] HTML description<\/p>",
        "questions_title": null,
        "questions": "<p>[EN] HTML questions<\/p>"
      },
      "it": {
        "page_title": "Titolo pagina in italiano",
        "description_title": null,
        "description": "<p>[IT] HTML description<\/p>",
        "questions_title": null,
        "questions": "<p>[IT] HTML questions<\/p>"
      }
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/projects/jotbars/info?id=f3b29067262c1168646f284423d6017e&format=xml

Query parameters

    id = f3b29067262c1168646f284423d6017e
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <logo>https://joturl.com/logo.svg</logo>  
    <logo_url>https://joturl.com/</logo_url>  
    <template>right</template>  
    <template_size>big</template_size>  
    <show_feedback></show_feedback>  
    <languages>en,it</languages>  
    <default_language></default_language>  
    <user_default_language>en</user_default_language>  
    <info>
      <en>
        <page_title>English page title</page_title>  
        <description_title></description_title>  
        <description><[CDATA[&lt;p&gt;[EN] HTML description&lt;/p&gt;]]></description>  
        <questions_title></questions_title>  
        <questions><[CDATA[&lt;p&gt;[EN] HTML questions&lt;/p&gt;]]></questions>  
      </en>  
      <it>
        <page_title>Titolo pagina in italiano</page_title>  
        <description_title></description_title>  
        <description><[CDATA[&lt;p&gt;[IT] HTML description&lt;/p&gt;]]></description>  
        <questions_title></questions_title>  
        <questions><[CDATA[&lt;p&gt;[IT] HTML questions&lt;/p&gt;]]></questions>  
      </it>  
    </info>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/projects/jotbars/info?id=f3b29067262c1168646f284423d6017e&format=txt

Query parameters

    id = f3b29067262c1168646f284423d6017e
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_logo=https://joturl.com/logo.svg
result_logo_url=https://joturl.com/
result_template=right
result_template_size=big
result_show_feedback=
result_languages=en,it
result_default_language=
result_user_default_language=en
result_info_en_page_title=English page title
result_info_en_description_title=
result_info_en_description=&lt;p&gt;[EN] HTML description&lt;/p&gt;
result_info_en_questions_title=
result_info_en_questions=&lt;p&gt;[EN] HTML questions&lt;/p&gt;
result_info_it_page_title=Titolo pagina in italiano
result_info_it_description_title=
result_info_it_description=&lt;p&gt;[IT] HTML description&lt;/p&gt;
result_info_it_questions_title=
result_info_it_questions=&lt;p&gt;[IT] HTML questions&lt;/p&gt;

Example 4 (plain)

Request

https://joturl.com/a/i1/projects/jotbars/info?id=f3b29067262c1168646f284423d6017e&format=plain

Query parameters

    id = f3b29067262c1168646f284423d6017e
format = plain

Response

https://joturl.com/logo.svg
https://joturl.com/
right
big

en,it

en
English page title

&lt;p&gt;[EN] HTML description&lt;/p&gt;

&lt;p&gt;[EN] HTML questions&lt;/p&gt;
Titolo pagina in italiano

&lt;p&gt;[IT] HTML description&lt;/p&gt;

&lt;p&gt;[IT] HTML questions&lt;/p&gt;
Required parameters
parameterdescription
idIDID of the project
Return values
parameterdescription
default_languagedefault language within languages, empty or null to inherit the configuration from the account-level settings
infofor each language in languages, it contains page_title, description_title, description, questions_title, questions, see the following notes for details
languagescomma-separated list of the languages selected for the jotbar, the jotbar will be shown to the user in the language the user has chosen in his/hers browser, if the user has an unsupported language the default language will be used (i.e., default_language if not empty, user_default_language otherwise)
logoit can be:

/projects/languages

/projects/languages/list

access: [READ]

This method returns a list of available languages for specific options (e.g., jotBar) of a project.

Example 1 (json)

Request

https://joturl.com/a/i1/projects/languages/list?id=4b7536db55aef497c9066b98b5a1dddb

Query parameters

id = 4b7536db55aef497c9066b98b5a1dddb

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "languages": [
      {
        "name": "en",
        "label": "English"
      },
      {
        "name": "it",
        "label": "Italiano"
      }
    ],
    "selected": [
      "en",
      "it"
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/projects/languages/list?id=4b7536db55aef497c9066b98b5a1dddb&format=xml

Query parameters

    id = 4b7536db55aef497c9066b98b5a1dddb
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <languages>
      <i0>
        <name>en</name>  
        <label>English</label>  
      </i0>  
      <i1>
        <name>it</name>  
        <label>Italiano</label>  
      </i1>  
    </languages>  
    <selected>
      <i0>en</i0>  
      <i1>it</i1>  
    </selected>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/projects/languages/list?id=4b7536db55aef497c9066b98b5a1dddb&format=txt

Query parameters

    id = 4b7536db55aef497c9066b98b5a1dddb
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_languages_0_name=en
result_languages_0_label=English
result_languages_1_name=it
result_languages_1_label=Italiano
result_selected_0=en
result_selected_1=it

Example 4 (plain)

Request

https://joturl.com/a/i1/projects/languages/list?id=4b7536db55aef497c9066b98b5a1dddb&format=plain

Query parameters

    id = 4b7536db55aef497c9066b98b5a1dddb
format = plain

Response

en
English
it
Italiano
en
it
Required parameters
parameterdescription
idIDID of the project
Return values
parameterdescription
languagesavailable languages
selectedarray of names of enabled languages

/projects/list

access: [READ]

This method returns a list of projects data, specified in a comma separated input called fields.

Example 1 (json)

Request

https://joturl.com/a/i1/projects/list?fields=name,id

Query parameters

fields = name,id

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": [
      {
        "name": "project 1",
        "id": "1572d153fece48823b812dadead9082b"
      },
      {
        "name": "project 2",
        "id": "18033dca92ea3f5b7f71cdc4bda83eb2"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/projects/list?fields=name,id&format=xml

Query parameters

fields = name,id
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <i0>
        <name>project 1</name>  
        <id>1572d153fece48823b812dadead9082b</id>  
      </i0>  
      <i1>
        <name>project 2</name>  
        <id>18033dca92ea3f5b7f71cdc4bda83eb2</id>  
      </i1>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/projects/list?fields=name,id&format=txt

Query parameters

fields = name,id
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_0_name=project 1
result_data_0_id=1572d153fece48823b812dadead9082b
result_data_1_name=project 2
result_data_1_id=18033dca92ea3f5b7f71cdc4bda83eb2

Example 4 (plain)

Request

https://joturl.com/a/i1/projects/list?fields=name,id&format=plain

Query parameters

fields = name,id
format = plain

Response

project 1
1572d153fece48823b812dadead9082b
project 2
18033dca92ea3f5b7f71cdc4bda83eb2
Required parameters
parameterdescription
fieldsARRAYcomma separated list of fields to return, available fields: client, conversions_visits, creation, ctas_visits, has_utm_parameters, id, name, qrcodes_visits, remarketings_visits, unique_visits, urls_count, visits, is_default, count
Optional parameters
parameterdescription
creatorSTRINGfilter projects by creator, available values: ID, all, me, others, only available for administrator users, see notes for details
end_dateSTRINGfilter projects created up to this date (inclusive)
lengthINTEGERextracts this number of items (maxmimum allowed: 100)
orderbyARRAYorders items by field, available fields: client, conversions_visits, creation, ctas_visits, has_utm_parameters, id, name, qrcodes_visits, remarketings_visits, unique_visits, urls_count, visits, is_default
searchSTRINGfilters items to be extracted by searching them
sortSTRINGsorts items in ascending (ASC) or descending (DESC) order
startINTEGERstarts to extract items from this position
start_dateSTRINGfilter projects created from this date (inclusive)
subuser_idIDID of the team member, when passed the field has_access is returned for each project, has_access = 1 if the team member has access to the project, has_access = 0 otherwise
whereSTRINGto be used in conjunction with search, specifies where to search and it can be both, projects or links; where = projects: search for projects matching the name or the notes (default); where = links: search for tracking links matching the short url or the destination URL where = both: search for both tracking links and projects;
with_alertsBOOLEANfilter projects with security alerts
Return values
parameterdescription
count[OPTIONAL] total number of projects, returned only if count is passed in fields
dataarray containing required information on projects the user has access to

/projects/options

/projects/options/info

access: [READ]

Returns the list of available options for a specific project. Further, this method returns the exclusion list and active options.

Example 1 (json)

Request

https://joturl.com/a/i1/projects/options/info?id=cd335d059685b7f46b9045e8f94a4fa3

Query parameters

id = cd335d059685b7f46b9045e8f94a4fa3

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "options": [
      "users",
      "jotbar",
      "defaults"
    ],
    "exclusions": [],
    "disabled": [],
    "active": [
      "defaults"
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/projects/options/info?id=cd335d059685b7f46b9045e8f94a4fa3&format=xml

Query parameters

    id = cd335d059685b7f46b9045e8f94a4fa3
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <options>
      <i0>users</i0>  
      <i1>jotbar</i1>  
      <i2>defaults</i2>  
    </options>  
    <exclusions>

    </exclusions>  
    <disabled>

    </disabled>  
    <active>
      <i0>defaults</i0>  
    </active>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/projects/options/info?id=cd335d059685b7f46b9045e8f94a4fa3&format=txt

Query parameters

    id = cd335d059685b7f46b9045e8f94a4fa3
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_options_0=users
result_options_1=jotbar
result_options_2=defaults
result_exclusions=
result_disabled=
result_active_0=defaults

Example 4 (plain)

Request

https://joturl.com/a/i1/projects/options/info?id=cd335d059685b7f46b9045e8f94a4fa3&format=plain

Query parameters

    id = cd335d059685b7f46b9045e8f94a4fa3
format = plain

Response

users
jotbar
defaults


defaults
Required parameters
parameterdescription
idIDID of the project
Return values
parameterdescription
activecurrently active options for the project
disableddisabled options for the project
exclusionsexclusion map between options, a list of pairs (option, list of incompatible options)
optionsavailable options for the project

/projects/subusers

/projects/subusers/grant

access: [WRITE]

Grants access to the project to specified team members.

Example 1 (json)

Request

https://joturl.com/a/i1/projects/subusers/grant?id=5a627c329e2f4812761a147539eebf53&add_ids=f48fcc4d29c3c3a4338490f80348744a,2a2e6a1c890aab65f3d97bc9ea5d6da4,4b055c03a1367163659c1e5dd54bfe1a&delete_ids=590095581ea33285f8a9edc1ab8b6222,7269f986a6ac1f1e1bdfa91f497d189e,13ee10ddb0967f603b67d044ea2e20fa,6a26ad54fd1e08679b6839f2a27d007f

Query parameters

        id = 5a627c329e2f4812761a147539eebf53
   add_ids = f48fcc4d29c3c3a4338490f80348744a,2a2e6a1c890aab65f3d97bc9ea5d6da4,4b055c03a1367163659c1e5dd54bfe1a
delete_ids = 590095581ea33285f8a9edc1ab8b6222,7269f986a6ac1f1e1bdfa91f497d189e,13ee10ddb0967f603b67d044ea2e20fa,6a26ad54fd1e08679b6839f2a27d007f

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "added": 3,
    "deleted": 4
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/projects/subusers/grant?id=5a627c329e2f4812761a147539eebf53&add_ids=f48fcc4d29c3c3a4338490f80348744a,2a2e6a1c890aab65f3d97bc9ea5d6da4,4b055c03a1367163659c1e5dd54bfe1a&delete_ids=590095581ea33285f8a9edc1ab8b6222,7269f986a6ac1f1e1bdfa91f497d189e,13ee10ddb0967f603b67d044ea2e20fa,6a26ad54fd1e08679b6839f2a27d007f&format=xml

Query parameters

        id = 5a627c329e2f4812761a147539eebf53
   add_ids = f48fcc4d29c3c3a4338490f80348744a,2a2e6a1c890aab65f3d97bc9ea5d6da4,4b055c03a1367163659c1e5dd54bfe1a
delete_ids = 590095581ea33285f8a9edc1ab8b6222,7269f986a6ac1f1e1bdfa91f497d189e,13ee10ddb0967f603b67d044ea2e20fa,6a26ad54fd1e08679b6839f2a27d007f
    format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <added>3</added>  
    <deleted>4</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/projects/subusers/grant?id=5a627c329e2f4812761a147539eebf53&add_ids=f48fcc4d29c3c3a4338490f80348744a,2a2e6a1c890aab65f3d97bc9ea5d6da4,4b055c03a1367163659c1e5dd54bfe1a&delete_ids=590095581ea33285f8a9edc1ab8b6222,7269f986a6ac1f1e1bdfa91f497d189e,13ee10ddb0967f603b67d044ea2e20fa,6a26ad54fd1e08679b6839f2a27d007f&format=txt

Query parameters

        id = 5a627c329e2f4812761a147539eebf53
   add_ids = f48fcc4d29c3c3a4338490f80348744a,2a2e6a1c890aab65f3d97bc9ea5d6da4,4b055c03a1367163659c1e5dd54bfe1a
delete_ids = 590095581ea33285f8a9edc1ab8b6222,7269f986a6ac1f1e1bdfa91f497d189e,13ee10ddb0967f603b67d044ea2e20fa,6a26ad54fd1e08679b6839f2a27d007f
    format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_added=3
result_deleted=4

Example 4 (plain)

Request

https://joturl.com/a/i1/projects/subusers/grant?id=5a627c329e2f4812761a147539eebf53&add_ids=f48fcc4d29c3c3a4338490f80348744a,2a2e6a1c890aab65f3d97bc9ea5d6da4,4b055c03a1367163659c1e5dd54bfe1a&delete_ids=590095581ea33285f8a9edc1ab8b6222,7269f986a6ac1f1e1bdfa91f497d189e,13ee10ddb0967f603b67d044ea2e20fa,6a26ad54fd1e08679b6839f2a27d007f&format=plain

Query parameters

        id = 5a627c329e2f4812761a147539eebf53
   add_ids = f48fcc4d29c3c3a4338490f80348744a,2a2e6a1c890aab65f3d97bc9ea5d6da4,4b055c03a1367163659c1e5dd54bfe1a
delete_ids = 590095581ea33285f8a9edc1ab8b6222,7269f986a6ac1f1e1bdfa91f497d189e,13ee10ddb0967f603b67d044ea2e20fa,6a26ad54fd1e08679b6839f2a27d007f
    format = plain

Response

3
4
Required parameters
parameterdescription
idIDID of the project
Optional parameters
parameterdescription
add_idsARRAY_OF_IDScomma-separated list of team members to grant access to the project
delete_idsARRAY_OF_IDScomma-separated list of team members to deny access to the project
Return values
parameterdescription
addednumber of team members who have been granted access to the project
deletednumber of team members who were denied access to the project

/projects/watchdogs

/projects/watchdogs/alerts

/projects/watchdogs/alerts/delete

access: [WRITE]

Reset watchdog alerts for a given array of project IDs.

Example 1 (json)

Request

https://joturl.com/a/i1/projects/watchdogs/alerts/delete?ids=8ba24fdffb090f1c16147233d674c442,ae551cbf2d2a007db6406b1cddf8b7b7,2b0d76918f3d726b818177ca78284efb,3397ed0b5edf1affdd3e82dfc16c5459

Query parameters

ids = 8ba24fdffb090f1c16147233d674c442,ae551cbf2d2a007db6406b1cddf8b7b7,2b0d76918f3d726b818177ca78284efb,3397ed0b5edf1affdd3e82dfc16c5459

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 40,
    "ids": [
      "8ba24fdffb090f1c16147233d674c442",
      "ae551cbf2d2a007db6406b1cddf8b7b7",
      "2b0d76918f3d726b818177ca78284efb",
      "3397ed0b5edf1affdd3e82dfc16c5459"
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/projects/watchdogs/alerts/delete?ids=8ba24fdffb090f1c16147233d674c442,ae551cbf2d2a007db6406b1cddf8b7b7,2b0d76918f3d726b818177ca78284efb,3397ed0b5edf1affdd3e82dfc16c5459&format=xml

Query parameters

   ids = 8ba24fdffb090f1c16147233d674c442,ae551cbf2d2a007db6406b1cddf8b7b7,2b0d76918f3d726b818177ca78284efb,3397ed0b5edf1affdd3e82dfc16c5459
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>40</count>  
    <ids>
      <i0>8ba24fdffb090f1c16147233d674c442</i0>  
      <i1>ae551cbf2d2a007db6406b1cddf8b7b7</i1>  
      <i2>2b0d76918f3d726b818177ca78284efb</i2>  
      <i3>3397ed0b5edf1affdd3e82dfc16c5459</i3>  
    </ids>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/projects/watchdogs/alerts/delete?ids=8ba24fdffb090f1c16147233d674c442,ae551cbf2d2a007db6406b1cddf8b7b7,2b0d76918f3d726b818177ca78284efb,3397ed0b5edf1affdd3e82dfc16c5459&format=txt

Query parameters

   ids = 8ba24fdffb090f1c16147233d674c442,ae551cbf2d2a007db6406b1cddf8b7b7,2b0d76918f3d726b818177ca78284efb,3397ed0b5edf1affdd3e82dfc16c5459
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=40
result_ids_0=8ba24fdffb090f1c16147233d674c442
result_ids_1=ae551cbf2d2a007db6406b1cddf8b7b7
result_ids_2=2b0d76918f3d726b818177ca78284efb
result_ids_3=3397ed0b5edf1affdd3e82dfc16c5459

Example 4 (plain)

Request

https://joturl.com/a/i1/projects/watchdogs/alerts/delete?ids=8ba24fdffb090f1c16147233d674c442,ae551cbf2d2a007db6406b1cddf8b7b7,2b0d76918f3d726b818177ca78284efb,3397ed0b5edf1affdd3e82dfc16c5459&format=plain

Query parameters

   ids = 8ba24fdffb090f1c16147233d674c442,ae551cbf2d2a007db6406b1cddf8b7b7,2b0d76918f3d726b818177ca78284efb,3397ed0b5edf1affdd3e82dfc16c5459
format = plain

Response

40
8ba24fdffb090f1c16147233d674c442
ae551cbf2d2a007db6406b1cddf8b7b7
2b0d76918f3d726b818177ca78284efb
3397ed0b5edf1affdd3e82dfc16c5459
Required parameters
parameterdescription
idsARRAY_OF_IDScomma-separated list of project IDs
Return values
parameterdescription
countnumber of resetted alerts, a maximum of 10000 alerts will be processed
idsarray containing IDs passed in the ids input parameter

/projects/webhooks

/projects/webhooks/info

access: [READ]

This method return information on a webhook.

Example 1 (json)

Request

https://joturl.com/a/i1/projects/webhooks/info?id=c5e08d83ffef85d8d7bd814a9dd5a945

Query parameters

id = c5e08d83ffef85d8d7bd814a9dd5a945

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "c5e08d83ffef85d8d7bd814a9dd5a945",
    "url": "https:\/\/my.custom.webhook\/",
    "type": "custom",
    "info": [],
    "notes": ""
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/projects/webhooks/info?id=c5e08d83ffef85d8d7bd814a9dd5a945&format=xml

Query parameters

    id = c5e08d83ffef85d8d7bd814a9dd5a945
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>c5e08d83ffef85d8d7bd814a9dd5a945</id>  
    <url>https://my.custom.webhook/</url>  
    <type>custom</type>  
    <info>

    </info>  
    <notes></notes>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/projects/webhooks/info?id=c5e08d83ffef85d8d7bd814a9dd5a945&format=txt

Query parameters

    id = c5e08d83ffef85d8d7bd814a9dd5a945
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=c5e08d83ffef85d8d7bd814a9dd5a945
result_url=https://my.custom.webhook/
result_type=custom
result_info=
result_notes=

Example 4 (plain)

Request

https://joturl.com/a/i1/projects/webhooks/info?id=c5e08d83ffef85d8d7bd814a9dd5a945&format=plain

Query parameters

    id = c5e08d83ffef85d8d7bd814a9dd5a945
format = plain

Response

c5e08d83ffef85d8d7bd814a9dd5a945
https://my.custom.webhook/
custom


Required parameters
parameterdescription
idIDID of the project from which to remove the webhook
Return values
parameterdescription
idecho back of the id input parameter
infoextended info of the webhook
notesnotes for the webhook
typewebhook type, see i1/ctas/webhooks/property for details
urlURL of the webhook

/projects/webhooks/property

access: [READ]

Return available webhook types and their parameters.

Example 1 (json)

Request

https://joturl.com/a/i1/projects/webhooks/property?types=custom,zapier

Query parameters

types = custom,zapier

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": {
      "custom": {
        "name": "Custom webhook",
        "private": 0,
        "url_required": 1,
        "info": {
          "home": "https:\/\/joturl.zendesk.com\/hc\/en-us\/articles\/360012882199",
          "logo": "data:image\/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB2ZXJzaW9uPSIxLjEiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8cGF0aCBkPSJtMjU2IDcuMzZjLTY1LjI1OSAwLTExOC40IDUzLjE0MS0xMTguNCAxMTguNCAwIDM4Ljk0MyAxOS4zMzMgNzMuMTIxIDQ4LjQ3IDk0LjcybC01OC40NiA5Ni41N2MtMC40NjItMC4xMzktMC45NzEtMC4yMzEtMS40OC0wLjM3LTEyLjIxLTMuMjg0LTI0LjkyOS0xLjQ4LTM1Ljg5IDQuODEtMjIuNjE2IDEzLjA4OS0zMC40MzIgNDIuMTM0LTE3LjM5IDY0Ljc1IDguNzQxIDE1LjE3IDI0LjY5NyAyMy42OCA0MS4wNyAyMy42OCA4LjA0NyAwIDE2LjIzNC0xLjk4OSAyMy42OC02LjI5IDEwLjk2MS02LjMzNiAxOC45MTYtMTYuNjUgMjIuMi0yOC44NnMxLjUyNi0yNC45MjktNC44MS0zNS44OWMtMS45ODktMy40MjItNC43MTgtNi40NzUtNy40LTkuMjVsNzAuNjctMTE2LjE4LTEwLjM2LTUuOTJjLTI3Ljg4OS0xNi40NjUtNDYuNjItNDYuOTQ0LTQ2LjYyLTgxLjc3IDAtNTIuNDQ4IDQyLjI3My05NC43MiA5NC43Mi05NC43MnM5NC43MiA0Mi4yNzIgOTQuNzIgOTQuNzJjMCA5Ljc1OS0xLjM0MSAxOC45MTYtNC4wNyAyNy43NWwyMi41NyA3LjAzYzMuNDIyLTExLjA1NCA1LjE4LTIyLjY2MiA1LjE4LTM0Ljc4IDAtNjUuMjU5LTUzLjE0MS0xMTguNC0xMTguNC0xMTguNHptMCA3MS4wNGMtMjYuMTMxIDAtNDcuMzYgMjEuMjI5LTQ3LjM2IDQ3LjM2czIxLjIyOSA0Ny4zNiA0Ny4zNiA0Ny4zNmMzLjkzMSAwIDcuODE2LTAuNTU1IDExLjQ3LTEuNDhsNTYuOTggMTAzLjIzIDUuNTUgMTAuMzYgMTAuNzMtNS41NWMxMy41NTEtNy40OTMgMjguOTA2LTExLjg0IDQ1LjUxLTExLjg0IDUyLjQ0OCAwIDk0LjcyIDQyLjI3MiA5NC43MiA5NC43MnMtNDIuMjczIDk0LjcyLTk0LjcyIDk0LjcyYy0yNS41NzYgMC00OC43OTQtMTAuMjIxLTY1Ljg2LTI2LjY0bC0xNi4yOCAxNy4wMmMyMS4yNzUgMjAuNDg5IDUwLjMyIDMzLjMgODIuMTQgMzMuMyA2NS4yNTkgMCAxMTguNC01My4xNDEgMTE4LjQtMTE4LjRzLTUzLjE0MS0xMTguNC0xMTguNC0xMTguNGMtMTYuNDE5IDAtMzEuNjM1IDQuMzAxLTQ1Ljg4IDEwLjM2bC01Mi4xNy05NC4zNWM5LjI1LTguNjQ5IDE1LjE3LTIwLjc2NiAxNS4xNy0zNC40MSAwLTI2LjEzMS0yMS4yMjktNDcuMzYtNDcuMzYtNDcuMzZ6bS0xNzAuOTQgMTY5LjA5Yy01MS41NjkgMTIuODU3LTg5LjU0IDU5LjcwOS04OS41NCAxMTUuMDcgMCA2NS4yNTkgNTMuMTQxIDExOC40IDExOC40IDExOC40IDYxLjA1IDAgMTA5Ljk0LTQ3LjEyOSAxMTYuMTgtMTA2LjU2aDExMC42M2M1LjI3MiAyMC4zOTYgMjMuNDk1IDM1LjUyIDQ1LjUxIDM1LjUyIDI2LjEzMSAwIDQ3LjM2LTIxLjIyOSA0Ny4zNi00Ny4zNnMtMjEuMjI5LTQ3LjM2LTQ3LjM2LTQ3LjM2Yy0yMi4wMTUgMC00MC4yMzggMTUuMTI0LTQ1LjUxIDM1LjUyaC0xMzIuMDl2MTEuODRjMCA1Mi40NDgtNDIuMjczIDk0LjcyLTk0LjcyIDk0Ljcycy05NC43Mi00Mi4yNzItOTQuNzItOTQuNzJjMC00NC40OTIgMzAuNjE4LTgxLjQ5MiA3MS43OC05MS43NnoiLz4KPC9zdmc+Cg=="
        },
        "parameters": [
          {
            "name": "fields",
            "type": "json",
            "maxlength": 2000,
            "description": "couples key\/values",
            "mandatory": 0,
            "example": "{\"source\":\"joturl\",\"test\":1}"
          }
        ]
      },
      "zapier": {
        "name": "Zapier",
        "private": 1,
        "url_required": 0,
        "info": {
          "home": "https:\/\/zapier.com\/",
          "logo": "https:\/\/cdn.zapier.com\/zapier\/images\/logos\/zapier-logo.png"
        },
        "parameters": []
      }
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/projects/webhooks/property?types=custom,zapier&format=xml

Query parameters

 types = custom,zapier
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <custom>
        <name>Custom webhook</name>  
        <private>0</private>  
        <url_required>1</url_required>  
        <info>
          <home>https://joturl.zendesk.com/hc/en-us/articles/360012882199</home>  
          <logo>data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB2ZXJzaW9uPSIxLjEiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8cGF0aCBkPSJtMjU2IDcuMzZjLTY1LjI1OSAwLTExOC40IDUzLjE0MS0xMTguNCAxMTguNCAwIDM4Ljk0MyAxOS4zMzMgNzMuMTIxIDQ4LjQ3IDk0LjcybC01OC40NiA5Ni41N2MtMC40NjItMC4xMzktMC45NzEtMC4yMzEtMS40OC0wLjM3LTEyLjIxLTMuMjg0LTI0LjkyOS0xLjQ4LTM1Ljg5IDQuODEtMjIuNjE2IDEzLjA4OS0zMC40MzIgNDIuMTM0LTE3LjM5IDY0Ljc1IDguNzQxIDE1LjE3IDI0LjY5NyAyMy42OCA0MS4wNyAyMy42OCA4LjA0NyAwIDE2LjIzNC0xLjk4OSAyMy42OC02LjI5IDEwLjk2MS02LjMzNiAxOC45MTYtMTYuNjUgMjIuMi0yOC44NnMxLjUyNi0yNC45MjktNC44MS0zNS44OWMtMS45ODktMy40MjItNC43MTgtNi40NzUtNy40LTkuMjVsNzAuNjctMTE2LjE4LTEwLjM2LTUuOTJjLTI3Ljg4OS0xNi40NjUtNDYuNjItNDYuOTQ0LTQ2LjYyLTgxLjc3IDAtNTIuNDQ4IDQyLjI3My05NC43MiA5NC43Mi05NC43MnM5NC43MiA0Mi4yNzIgOTQuNzIgOTQuNzJjMCA5Ljc1OS0xLjM0MSAxOC45MTYtNC4wNyAyNy43NWwyMi41NyA3LjAzYzMuNDIyLTExLjA1NCA1LjE4LTIyLjY2MiA1LjE4LTM0Ljc4IDAtNjUuMjU5LTUzLjE0MS0xMTguNC0xMTguNC0xMTguNHptMCA3MS4wNGMtMjYuMTMxIDAtNDcuMzYgMjEuMjI5LTQ3LjM2IDQ3LjM2czIxLjIyOSA0Ny4zNiA0Ny4zNiA0Ny4zNmMzLjkzMSAwIDcuODE2LTAuNTU1IDExLjQ3LTEuNDhsNTYuOTggMTAzLjIzIDUuNTUgMTAuMzYgMTAuNzMtNS41NWMxMy41NTEtNy40OTMgMjguOTA2LTExLjg0IDQ1LjUxLTExLjg0IDUyLjQ0OCAwIDk0LjcyIDQyLjI3MiA5NC43MiA5NC43MnMtNDIuMjczIDk0LjcyLTk0LjcyIDk0LjcyYy0yNS41NzYgMC00OC43OTQtMTAuMjIxLTY1Ljg2LTI2LjY0bC0xNi4yOCAxNy4wMmMyMS4yNzUgMjAuNDg5IDUwLjMyIDMzLjMgODIuMTQgMzMuMyA2NS4yNTkgMCAxMTguNC01My4xNDEgMTE4LjQtMTE4LjRzLTUzLjE0MS0xMTguNC0xMTguNC0xMTguNGMtMTYuNDE5IDAtMzEuNjM1IDQuMzAxLTQ1Ljg4IDEwLjM2bC01Mi4xNy05NC4zNWM5LjI1LTguNjQ5IDE1LjE3LTIwLjc2NiAxNS4xNy0zNC40MSAwLTI2LjEzMS0yMS4yMjktNDcuMzYtNDcuMzYtNDcuMzZ6bS0xNzAuOTQgMTY5LjA5Yy01MS41NjkgMTIuODU3LTg5LjU0IDU5LjcwOS04OS41NCAxMTUuMDcgMCA2NS4yNTkgNTMuMTQxIDExOC40IDExOC40IDExOC40IDYxLjA1IDAgMTA5Ljk0LTQ3LjEyOSAxMTYuMTgtMTA2LjU2aDExMC42M2M1LjI3MiAyMC4zOTYgMjMuNDk1IDM1LjUyIDQ1LjUxIDM1LjUyIDI2LjEzMSAwIDQ3LjM2LTIxLjIyOSA0Ny4zNi00Ny4zNnMtMjEuMjI5LTQ3LjM2LTQ3LjM2LTQ3LjM2Yy0yMi4wMTUgMC00MC4yMzggMTUuMTI0LTQ1LjUxIDM1LjUyaC0xMzIuMDl2MTEuODRjMCA1Mi40NDgtNDIuMjczIDk0LjcyLTk0LjcyIDk0Ljcycy05NC43Mi00Mi4yNzItOTQuNzItOTQuNzJjMC00NC40OTIgMzAuNjE4LTgxLjQ5MiA3MS43OC05MS43NnoiLz4KPC9zdmc+Cg==</logo>  
        </info>  
        <parameters>
          <i0>
            <name>fields</name>  
            <type>json</type>  
            <maxlength>2000</maxlength>  
            <description>couples key/values</description>  
            <mandatory>0</mandatory>  
            <example>{"source":"joturl","test":1}</example>  
          </i0>  
        </parameters>  
      </custom>  
      <zapier>
        <name>Zapier</name>  
        <private>1</private>  
        <url_required>0</url_required>  
        <info>
          <home>https://zapier.com/</home>  
          <logo>https://cdn.zapier.com/zapier/images/logos/zapier-logo.png</logo>  
        </info>  
        <parameters>

        </parameters>  
      </zapier>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/projects/webhooks/property?types=custom,zapier&format=txt

Query parameters

 types = custom,zapier
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_custom_name=Custom webhook
result_data_custom_private=0
result_data_custom_url_required=1
result_data_custom_info_home=https://joturl.zendesk.com/hc/en-us/articles/360012882199
result_data_custom_info_logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB2ZXJzaW9uPSIxLjEiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8cGF0aCBkPSJtMjU2IDcuMzZjLTY1LjI1OSAwLTExOC40IDUzLjE0MS0xMTguNCAxMTguNCAwIDM4Ljk0MyAxOS4zMzMgNzMuMTIxIDQ4LjQ3IDk0LjcybC01OC40NiA5Ni41N2MtMC40NjItMC4xMzktMC45NzEtMC4yMzEtMS40OC0wLjM3LTEyLjIxLTMuMjg0LTI0LjkyOS0xLjQ4LTM1Ljg5IDQuODEtMjIuNjE2IDEzLjA4OS0zMC40MzIgNDIuMTM0LTE3LjM5IDY0Ljc1IDguNzQxIDE1LjE3IDI0LjY5NyAyMy42OCA0MS4wNyAyMy42OCA4LjA0NyAwIDE2LjIzNC0xLjk4OSAyMy42OC02LjI5IDEwLjk2MS02LjMzNiAxOC45MTYtMTYuNjUgMjIuMi0yOC44NnMxLjUyNi0yNC45MjktNC44MS0zNS44OWMtMS45ODktMy40MjItNC43MTgtNi40NzUtNy40LTkuMjVsNzAuNjctMTE2LjE4LTEwLjM2LTUuOTJjLTI3Ljg4OS0xNi40NjUtNDYuNjItNDYuOTQ0LTQ2LjYyLTgxLjc3IDAtNTIuNDQ4IDQyLjI3My05NC43MiA5NC43Mi05NC43MnM5NC43MiA0Mi4yNzIgOTQuNzIgOTQuNzJjMCA5Ljc1OS0xLjM0MSAxOC45MTYtNC4wNyAyNy43NWwyMi41NyA3LjAzYzMuNDIyLTExLjA1NCA1LjE4LTIyLjY2MiA1LjE4LTM0Ljc4IDAtNjUuMjU5LTUzLjE0MS0xMTguNC0xMTguNC0xMTguNHptMCA3MS4wNGMtMjYuMTMxIDAtNDcuMzYgMjEuMjI5LTQ3LjM2IDQ3LjM2czIxLjIyOSA0Ny4zNiA0Ny4zNiA0Ny4zNmMzLjkzMSAwIDcuODE2LTAuNTU1IDExLjQ3LTEuNDhsNTYuOTggMTAzLjIzIDUuNTUgMTAuMzYgMTAuNzMtNS41NWMxMy41NTEtNy40OTMgMjguOTA2LTExLjg0IDQ1LjUxLTExLjg0IDUyLjQ0OCAwIDk0LjcyIDQyLjI3MiA5NC43MiA5NC43MnMtNDIuMjczIDk0LjcyLTk0LjcyIDk0LjcyYy0yNS41NzYgMC00OC43OTQtMTAuMjIxLTY1Ljg2LTI2LjY0bC0xNi4yOCAxNy4wMmMyMS4yNzUgMjAuNDg5IDUwLjMyIDMzLjMgODIuMTQgMzMuMyA2NS4yNTkgMCAxMTguNC01My4xNDEgMTE4LjQtMTE4LjRzLTUzLjE0MS0xMTguNC0xMTguNC0xMTguNGMtMTYuNDE5IDAtMzEuNjM1IDQuMzAxLTQ1Ljg4IDEwLjM2bC01Mi4xNy05NC4zNWM5LjI1LTguNjQ5IDE1LjE3LTIwLjc2NiAxNS4xNy0zNC40MSAwLTI2LjEzMS0yMS4yMjktNDcuMzYtNDcuMzYtNDcuMzZ6bS0xNzAuOTQgMTY5LjA5Yy01MS41NjkgMTIuODU3LTg5LjU0IDU5LjcwOS04OS41NCAxMTUuMDcgMCA2NS4yNTkgNTMuMTQxIDExOC40IDExOC40IDExOC40IDYxLjA1IDAgMTA5Ljk0LTQ3LjEyOSAxMTYuMTgtMTA2LjU2aDExMC42M2M1LjI3MiAyMC4zOTYgMjMuNDk1IDM1LjUyIDQ1LjUxIDM1LjUyIDI2LjEzMSAwIDQ3LjM2LTIxLjIyOSA0Ny4zNi00Ny4zNnMtMjEuMjI5LTQ3LjM2LTQ3LjM2LTQ3LjM2Yy0yMi4wMTUgMC00MC4yMzggMTUuMTI0LTQ1LjUxIDM1LjUyaC0xMzIuMDl2MTEuODRjMCA1Mi40NDgtNDIuMjczIDk0LjcyLTk0LjcyIDk0Ljcycy05NC43Mi00Mi4yNzItOTQuNzItOTQuNzJjMC00NC40OTIgMzAuNjE4LTgxLjQ5MiA3MS43OC05MS43NnoiLz4KPC9zdmc+Cg==
result_data_custom_parameters_0_name=fields
result_data_custom_parameters_0_type=json
result_data_custom_parameters_0_maxlength=2000
result_data_custom_parameters_0_description=couples key/values
result_data_custom_parameters_0_mandatory=0
result_data_custom_parameters_0_example={"source":"joturl","test":1}
result_data_zapier_name=Zapier
result_data_zapier_private=1
result_data_zapier_url_required=0
result_data_zapier_info_home=https://zapier.com/
result_data_zapier_info_logo=https://cdn.zapier.com/zapier/images/logos/zapier-logo.png
result_data_zapier_parameters=

Example 4 (plain)

Request

https://joturl.com/a/i1/projects/webhooks/property?types=custom,zapier&format=plain

Query parameters

 types = custom,zapier
format = plain

Response

Custom webhook
0
1
https://joturl.zendesk.com/hc/en-us/articles/360012882199
data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB2ZXJzaW9uPSIxLjEiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8cGF0aCBkPSJtMjU2IDcuMzZjLTY1LjI1OSAwLTExOC40IDUzLjE0MS0xMTguNCAxMTguNCAwIDM4Ljk0MyAxOS4zMzMgNzMuMTIxIDQ4LjQ3IDk0LjcybC01OC40NiA5Ni41N2MtMC40NjItMC4xMzktMC45NzEtMC4yMzEtMS40OC0wLjM3LTEyLjIxLTMuMjg0LTI0LjkyOS0xLjQ4LTM1Ljg5IDQuODEtMjIuNjE2IDEzLjA4OS0zMC40MzIgNDIuMTM0LTE3LjM5IDY0Ljc1IDguNzQxIDE1LjE3IDI0LjY5NyAyMy42OCA0MS4wNyAyMy42OCA4LjA0NyAwIDE2LjIzNC0xLjk4OSAyMy42OC02LjI5IDEwLjk2MS02LjMzNiAxOC45MTYtMTYuNjUgMjIuMi0yOC44NnMxLjUyNi0yNC45MjktNC44MS0zNS44OWMtMS45ODktMy40MjItNC43MTgtNi40NzUtNy40LTkuMjVsNzAuNjctMTE2LjE4LTEwLjM2LTUuOTJjLTI3Ljg4OS0xNi40NjUtNDYuNjItNDYuOTQ0LTQ2LjYyLTgxLjc3IDAtNTIuNDQ4IDQyLjI3My05NC43MiA5NC43Mi05NC43MnM5NC43MiA0Mi4yNzIgOTQuNzIgOTQuNzJjMCA5Ljc1OS0xLjM0MSAxOC45MTYtNC4wNyAyNy43NWwyMi41NyA3LjAzYzMuNDIyLTExLjA1NCA1LjE4LTIyLjY2MiA1LjE4LTM0Ljc4IDAtNjUuMjU5LTUzLjE0MS0xMTguNC0xMTguNC0xMTguNHptMCA3MS4wNGMtMjYuMTMxIDAtNDcuMzYgMjEuMjI5LTQ3LjM2IDQ3LjM2czIxLjIyOSA0Ny4zNiA0Ny4zNiA0Ny4zNmMzLjkzMSAwIDcuODE2LTAuNTU1IDExLjQ3LTEuNDhsNTYuOTggMTAzLjIzIDUuNTUgMTAuMzYgMTAuNzMtNS41NWMxMy41NTEtNy40OTMgMjguOTA2LTExLjg0IDQ1LjUxLTExLjg0IDUyLjQ0OCAwIDk0LjcyIDQyLjI3MiA5NC43MiA5NC43MnMtNDIuMjczIDk0LjcyLTk0LjcyIDk0LjcyYy0yNS41NzYgMC00OC43OTQtMTAuMjIxLTY1Ljg2LTI2LjY0bC0xNi4yOCAxNy4wMmMyMS4yNzUgMjAuNDg5IDUwLjMyIDMzLjMgODIuMTQgMzMuMyA2NS4yNTkgMCAxMTguNC01My4xNDEgMTE4LjQtMTE4LjRzLTUzLjE0MS0xMTguNC0xMTguNC0xMTguNGMtMTYuNDE5IDAtMzEuNjM1IDQuMzAxLTQ1Ljg4IDEwLjM2bC01Mi4xNy05NC4zNWM5LjI1LTguNjQ5IDE1LjE3LTIwLjc2NiAxNS4xNy0zNC40MSAwLTI2LjEzMS0yMS4yMjktNDcuMzYtNDcuMzYtNDcuMzZ6bS0xNzAuOTQgMTY5LjA5Yy01MS41NjkgMTIuODU3LTg5LjU0IDU5LjcwOS04OS41NCAxMTUuMDcgMCA2NS4yNTkgNTMuMTQxIDExOC40IDExOC40IDExOC40IDYxLjA1IDAgMTA5Ljk0LTQ3LjEyOSAxMTYuMTgtMTA2LjU2aDExMC42M2M1LjI3MiAyMC4zOTYgMjMuNDk1IDM1LjUyIDQ1LjUxIDM1LjUyIDI2LjEzMSAwIDQ3LjM2LTIxLjIyOSA0Ny4zNi00Ny4zNnMtMjEuMjI5LTQ3LjM2LTQ3LjM2LTQ3LjM2Yy0yMi4wMTUgMC00MC4yMzggMTUuMTI0LTQ1LjUxIDM1LjUyaC0xMzIuMDl2MTEuODRjMCA1Mi40NDgtNDIuMjczIDk0LjcyLTk0LjcyIDk0Ljcycy05NC43Mi00Mi4yNzItOTQuNzItOTQuNzJjMC00NC40OTIgMzAuNjE4LTgxLjQ5MiA3MS43OC05MS43NnoiLz4KPC9zdmc+Cg==
fields
json
2000
couples key/values
0
{"source":"joturl","test":1}
Zapier
1
0
https://zapier.com/
https://cdn.zapier.com/zapier/images/logos/zapier-logo.png

Optional parameters
parameterdescription
typesSTRINGcomma-separated list of webhook types to be returned, if empty all types are returned, available types: custom, zapier
Return values
parameterdescription
dataarray containing information on webhook parameters by type

/projects/webhooks/subscribe

access: [WRITE]

This method add a webhook subscription to a project.

Example 1 (json)

Request

https://joturl.com/a/i1/projects/webhooks/subscribe?id=d79b2309ed5dd9a77d4996bf7f821e34&url=https%3A%2F%2Fjoturl.com%2F

Query parameters

 id = d79b2309ed5dd9a77d4996bf7f821e34
url = https://joturl.com/

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "added": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/projects/webhooks/subscribe?id=d79b2309ed5dd9a77d4996bf7f821e34&url=https%3A%2F%2Fjoturl.com%2F&format=xml

Query parameters

    id = d79b2309ed5dd9a77d4996bf7f821e34
   url = https://joturl.com/
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <added>1</added>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/projects/webhooks/subscribe?id=d79b2309ed5dd9a77d4996bf7f821e34&url=https%3A%2F%2Fjoturl.com%2F&format=txt

Query parameters

    id = d79b2309ed5dd9a77d4996bf7f821e34
   url = https://joturl.com/
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_added=1

Example 4 (plain)

Request

https://joturl.com/a/i1/projects/webhooks/subscribe?id=d79b2309ed5dd9a77d4996bf7f821e34&url=https%3A%2F%2Fjoturl.com%2F&format=plain

Query parameters

    id = d79b2309ed5dd9a77d4996bf7f821e34
   url = https://joturl.com/
format = plain

Response

1
Required parameters
parameterdescription
idIDID of the project to which to add the webhook
typeSTRINGwebhook type, allowed types: custom, zapier
Optional parameters
parameterdescriptionmax length
infoJSONinfo to be used with the webhook (e.g., an API key), see below for details
notesSTRINGnotes for the webhook4000
unsubscribeBOOLEAN1 to unsubscribe from the current webhook (if any) and subscribe to the new one
urlSTRINGURL of the webhook, required for types: custom, zapier4000
Return values
parameterdescription
added1 on success, 0 otherwise

/projects/webhooks/test

access: [WRITE]

This endpoint sends test data to a project webhook.

Example 1 (json)

Request

https://joturl.com/a/i1/projects/webhooks/test?id=b2d011d41278cfb7a5cda9fc36d739f0

Query parameters

id = b2d011d41278cfb7a5cda9fc36d739f0

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "ok": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/projects/webhooks/test?id=b2d011d41278cfb7a5cda9fc36d739f0&format=xml

Query parameters

    id = b2d011d41278cfb7a5cda9fc36d739f0
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <ok>1</ok>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/projects/webhooks/test?id=b2d011d41278cfb7a5cda9fc36d739f0&format=txt

Query parameters

    id = b2d011d41278cfb7a5cda9fc36d739f0
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_ok=1

Example 4 (plain)

Request

https://joturl.com/a/i1/projects/webhooks/test?id=b2d011d41278cfb7a5cda9fc36d739f0&format=plain

Query parameters

    id = b2d011d41278cfb7a5cda9fc36d739f0
format = plain

Response

1
Required parameters
parameterdescription
idIDID of the project associated with the webhook
Return values
parameterdescription
ok1 on success, otherwise an error is returned

/projects/webhooks/unsubscribe

access: [WRITE]

This method removes a webhook subscription to a project.

Example 1 (json)

Request

https://joturl.com/a/i1/projects/webhooks/unsubscribe?id=66416fa7d96f783331adfaaad194e8af

Query parameters

id = 66416fa7d96f783331adfaaad194e8af

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "removed": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/projects/webhooks/unsubscribe?id=66416fa7d96f783331adfaaad194e8af&format=xml

Query parameters

    id = 66416fa7d96f783331adfaaad194e8af
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <removed>1</removed>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/projects/webhooks/unsubscribe?id=66416fa7d96f783331adfaaad194e8af&format=txt

Query parameters

    id = 66416fa7d96f783331adfaaad194e8af
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_removed=1

Example 4 (plain)

Request

https://joturl.com/a/i1/projects/webhooks/unsubscribe?id=66416fa7d96f783331adfaaad194e8af&format=plain

Query parameters

    id = 66416fa7d96f783331adfaaad194e8af
format = plain

Response

1
Required parameters
parameterdescription
idIDID of the project from which to remove the webhook
Return values
parameterdescription
removed1 on success, 0 otherwise

/provinces

/provinces/list

access: [READ]

This method returns a list of available Italian provinces.

Example 1 (json)

Request

https://joturl.com/a/i1/provinces/list

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "provinces": [
      {
        "label": "Agrigento",
        "code": "AG"
      },
      {
        "label": "Alessandria",
        "code": "AL"
      },
      {
        "label": "Ancona",
        "code": "AN"
      },
      {
        "label": "Aosta",
        "code": "AO"
      },
      {
        "label": "Arezzo",
        "code": "AR"
      },
      {
        "label": "Ascoli Piceno",
        "code": "AP"
      },
      {
        "label": "Asti",
        "code": "AT"
      },
      {
        "label": "Avellino",
        "code": "AV"
      },
      {
        "label": "Barletta-Andria-Trani",
        "code": "BT"
      },
      {
        "label": "Belluno",
        "code": "BL"
      },
      {
        "label": "Benevento",
        "code": "BN"
      },
      {
        "label": "Bergamo",
        "code": "BG"
      },
      {
        "label": "Biella",
        "code": "BI"
      },
      {
        "label": "Bolzano",
        "code": "BZ"
      },
      {
        "label": "Brescia",
        "code": "BS"
      },
      {
        "label": "Brindisi",
        "code": "BR"
      },
      {
        "label": "Caltanissetta",
        "code": "CL"
      },
      {
        "label": "Campobasso",
        "code": "CB"
      },
      {
        "label": "Caserta",
        "code": "CE"
      },
      {
        "label": "Catanzaro",
        "code": "CZ"
      },
      {
        "label": "Chieti",
        "code": "CH"
      },
      {
        "label": "Como",
        "code": "CO"
      },
      {
        "label": "Cosenza",
        "code": "CS"
      },
      {
        "label": "Cremona",
        "code": "CR"
      },
      {
        "label": "Crotone",
        "code": "KR"
      },
      {
        "label": "Cuneo",
        "code": "CN"
      },
      {
        "label": "Enna",
        "code": "EN"
      },
      {
        "label": "Fermo",
        "code": "FM"
      },
      {
        "label": "Ferrara",
        "code": "FE"
      },
      {
        "label": "Foggia",
        "code": "FG"
      },
      {
        "label": "Forlì-Cesena",
        "code": "FC"
      },
      {
        "label": "Frosinone",
        "code": "FR"
      },
      {
        "label": "Gorizia",
        "code": "GO"
      },
      {
        "label": "Grosseto",
        "code": "GR"
      },
      {
        "label": "Imperia",
        "code": "IM"
      },
      {
        "label": "Isernia",
        "code": "IS"
      },
      {
        "label": "L'Aquila",
        "code": "AQ"
      },
      {
        "label": "LaSpezia",
        "code": "SP"
      },
      {
        "label": "Latina",
        "code": "LT"
      },
      {
        "label": "Lecce",
        "code": "LE"
      },
      {
        "label": "Lecco",
        "code": "LC"
      },
      {
        "label": "Livorno",
        "code": "LI"
      },
      {
        "label": "Lodi",
        "code": "LO"
      },
      {
        "label": "Lucca",
        "code": "LU"
      },
      {
        "label": "Macerata",
        "code": "MC"
      },
      {
        "label": "Mantova",
        "code": "MN"
      },
      {
        "label": "Massa-Carrara",
        "code": "MS"
      },
      {
        "label": "Matera",
        "code": "MT"
      },
      {
        "label": "Modena",
        "code": "MO"
      },
      {
        "label": "Monzae Brianza",
        "code": "MB"
      },
      {
        "label": "Novara",
        "code": "NO"
      },
      {
        "label": "Nuoro",
        "code": "NU"
      },
      {
        "label": "Oristano",
        "code": "OR"
      },
      {
        "label": "Padova",
        "code": "PD"
      },
      {
        "label": "Parma",
        "code": "PR"
      },
      {
        "label": "Pavia",
        "code": "PV"
      },
      {
        "label": "Perugia",
        "code": "PG"
      },
      {
        "label": "Pesaro e Urbino",
        "code": "PU"
      },
      {
        "label": "Pescara",
        "code": "PE"
      },
      {
        "label": "Piacenza",
        "code": "PC"
      },
      {
        "label": "Pisa",
        "code": "PI"
      },
      {
        "label": "Pistoia",
        "code": "PT"
      },
      {
        "label": "Pordenone",
        "code": "PN"
      },
      {
        "label": "Potenza",
        "code": "PZ"
      },
      {
        "label": "Prato",
        "code": "PO"
      },
      {
        "label": "Ragusa",
        "code": "RG"
      },
      {
        "label": "Ravenna",
        "code": "RA"
      },
      {
        "label": "Reggio Emilia",
        "code": "RE"
      },
      {
        "label": "Rieti",
        "code": "RI"
      },
      {
        "label": "Rimini",
        "code": "RN"
      },
      {
        "label": "Rovigo",
        "code": "RO"
      },
      {
        "label": "Salerno",
        "code": "SA"
      },
      {
        "label": "Sassari",
        "code": "SS"
      },
      {
        "label": "Savona",
        "code": "SV"
      },
      {
        "label": "Siena",
        "code": "SI"
      },
      {
        "label": "Siracusa",
        "code": "SR"
      },
      {
        "label": "Sondrio",
        "code": "SO"
      },
      {
        "label": "Sud Sardegna",
        "code": "SU"
      },
      {
        "label": "Taranto",
        "code": "TA"
      },
      {
        "label": "Teramo",
        "code": "TE"
      },
      {
        "label": "Terni",
        "code": "TR"
      },
      {
        "label": "Trapani",
        "code": "TP"
      },
      {
        "label": "Trento",
        "code": "TN"
      },
      {
        "label": "Treviso",
        "code": "TV"
      },
      {
        "label": "Trieste",
        "code": "TS"
      },
      {
        "label": "Udine",
        "code": "UD"
      },
      {
        "label": "Varese",
        "code": "VA"
      },
      {
        "label": "Verbano-Cusio-Ossola",
        "code": "VB"
      },
      {
        "label": "Vercelli",
        "code": "VC"
      },
      {
        "label": "Verona",
        "code": "VR"
      },
      {
        "label": "Vibo Valentia",
        "code": "VV"
      },
      {
        "label": "Vicenza",
        "code": "VI"
      },
      {
        "label": "Viterbo",
        "code": "VT"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/provinces/list?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <provinces>
      <i0>
        <label>Agrigento</label>  
        <code>AG</code>  
      </i0>  
      <i1>
        <label>Alessandria</label>  
        <code>AL</code>  
      </i1>  
      <i2>
        <label>Ancona</label>  
        <code>AN</code>  
      </i2>  
      <i3>
        <label>Aosta</label>  
        <code>AO</code>  
      </i3>  
      <i4>
        <label>Arezzo</label>  
        <code>AR</code>  
      </i4>  
      <i5>
        <label>Ascoli Piceno</label>  
        <code>AP</code>  
      </i5>  
      <i6>
        <label>Asti</label>  
        <code>AT</code>  
      </i6>  
      <i7>
        <label>Avellino</label>  
        <code>AV</code>  
      </i7>  
      <i8>
        <label>Barletta-Andria-Trani</label>  
        <code>BT</code>  
      </i8>  
      <i9>
        <label>Belluno</label>  
        <code>BL</code>  
      </i9>  
      <i10>
        <label>Benevento</label>  
        <code>BN</code>  
      </i10>  
      <i11>
        <label>Bergamo</label>  
        <code>BG</code>  
      </i11>  
      <i12>
        <label>Biella</label>  
        <code>BI</code>  
      </i12>  
      <i13>
        <label>Bolzano</label>  
        <code>BZ</code>  
      </i13>  
      <i14>
        <label>Brescia</label>  
        <code>BS</code>  
      </i14>  
      <i15>
        <label>Brindisi</label>  
        <code>BR</code>  
      </i15>  
      <i16>
        <label>Caltanissetta</label>  
        <code>CL</code>  
      </i16>  
      <i17>
        <label>Campobasso</label>  
        <code>CB</code>  
      </i17>  
      <i18>
        <label>Caserta</label>  
        <code>CE</code>  
      </i18>  
      <i19>
        <label>Catanzaro</label>  
        <code>CZ</code>  
      </i19>  
      <i20>
        <label>Chieti</label>  
        <code>CH</code>  
      </i20>  
      <i21>
        <label>Como</label>  
        <code>CO</code>  
      </i21>  
      <i22>
        <label>Cosenza</label>  
        <code>CS</code>  
      </i22>  
      <i23>
        <label>Cremona</label>  
        <code>CR</code>  
      </i23>  
      <i24>
        <label>Crotone</label>  
        <code>KR</code>  
      </i24>  
      <i25>
        <label>Cuneo</label>  
        <code>CN</code>  
      </i25>  
      <i26>
        <label>Enna</label>  
        <code>EN</code>  
      </i26>  
      <i27>
        <label>Fermo</label>  
        <code>FM</code>  
      </i27>  
      <i28>
        <label>Ferrara</label>  
        <code>FE</code>  
      </i28>  
      <i29>
        <label>Foggia</label>  
        <code>FG</code>  
      </i29>  
      <i30>
        <label><[CDATA[Forl&igrave;-Cesena]]></label>  
        <code>FC</code>  
      </i30>  
      <i31>
        <label>Frosinone</label>  
        <code>FR</code>  
      </i31>  
      <i32>
        <label>Gorizia</label>  
        <code>GO</code>  
      </i32>  
      <i33>
        <label>Grosseto</label>  
        <code>GR</code>  
      </i33>  
      <i34>
        <label>Imperia</label>  
        <code>IM</code>  
      </i34>  
      <i35>
        <label>Isernia</label>  
        <code>IS</code>  
      </i35>  
      <i36>
        <label>L'Aquila</label>  
        <code>AQ</code>  
      </i36>  
      <i37>
        <label>LaSpezia</label>  
        <code>SP</code>  
      </i37>  
      <i38>
        <label>Latina</label>  
        <code>LT</code>  
      </i38>  
      <i39>
        <label>Lecce</label>  
        <code>LE</code>  
      </i39>  
      <i40>
        <label>Lecco</label>  
        <code>LC</code>  
      </i40>  
      <i41>
        <label>Livorno</label>  
        <code>LI</code>  
      </i41>  
      <i42>
        <label>Lodi</label>  
        <code>LO</code>  
      </i42>  
      <i43>
        <label>Lucca</label>  
        <code>LU</code>  
      </i43>  
      <i44>
        <label>Macerata</label>  
        <code>MC</code>  
      </i44>  
      <i45>
        <label>Mantova</label>  
        <code>MN</code>  
      </i45>  
      <i46>
        <label>Massa-Carrara</label>  
        <code>MS</code>  
      </i46>  
      <i47>
        <label>Matera</label>  
        <code>MT</code>  
      </i47>  
      <i48>
        <label>Modena</label>  
        <code>MO</code>  
      </i48>  
      <i49>
        <label>Monzae Brianza</label>  
        <code>MB</code>  
      </i49>  
      <i50>
        <label>Novara</label>  
        <code>NO</code>  
      </i50>  
      <i51>
        <label>Nuoro</label>  
        <code>NU</code>  
      </i51>  
      <i52>
        <label>Oristano</label>  
        <code>OR</code>  
      </i52>  
      <i53>
        <label>Padova</label>  
        <code>PD</code>  
      </i53>  
      <i54>
        <label>Parma</label>  
        <code>PR</code>  
      </i54>  
      <i55>
        <label>Pavia</label>  
        <code>PV</code>  
      </i55>  
      <i56>
        <label>Perugia</label>  
        <code>PG</code>  
      </i56>  
      <i57>
        <label>Pesaro e Urbino</label>  
        <code>PU</code>  
      </i57>  
      <i58>
        <label>Pescara</label>  
        <code>PE</code>  
      </i58>  
      <i59>
        <label>Piacenza</label>  
        <code>PC</code>  
      </i59>  
      <i60>
        <label>Pisa</label>  
        <code>PI</code>  
      </i60>  
      <i61>
        <label>Pistoia</label>  
        <code>PT</code>  
      </i61>  
      <i62>
        <label>Pordenone</label>  
        <code>PN</code>  
      </i62>  
      <i63>
        <label>Potenza</label>  
        <code>PZ</code>  
      </i63>  
      <i64>
        <label>Prato</label>  
        <code>PO</code>  
      </i64>  
      <i65>
        <label>Ragusa</label>  
        <code>RG</code>  
      </i65>  
      <i66>
        <label>Ravenna</label>  
        <code>RA</code>  
      </i66>  
      <i67>
        <label>Reggio Emilia</label>  
        <code>RE</code>  
      </i67>  
      <i68>
        <label>Rieti</label>  
        <code>RI</code>  
      </i68>  
      <i69>
        <label>Rimini</label>  
        <code>RN</code>  
      </i69>  
      <i70>
        <label>Rovigo</label>  
        <code>RO</code>  
      </i70>  
      <i71>
        <label>Salerno</label>  
        <code>SA</code>  
      </i71>  
      <i72>
        <label>Sassari</label>  
        <code>SS</code>  
      </i72>  
      <i73>
        <label>Savona</label>  
        <code>SV</code>  
      </i73>  
      <i74>
        <label>Siena</label>  
        <code>SI</code>  
      </i74>  
      <i75>
        <label>Siracusa</label>  
        <code>SR</code>  
      </i75>  
      <i76>
        <label>Sondrio</label>  
        <code>SO</code>  
      </i76>  
      <i77>
        <label>Sud Sardegna</label>  
        <code>SU</code>  
      </i77>  
      <i78>
        <label>Taranto</label>  
        <code>TA</code>  
      </i78>  
      <i79>
        <label>Teramo</label>  
        <code>TE</code>  
      </i79>  
      <i80>
        <label>Terni</label>  
        <code>TR</code>  
      </i80>  
      <i81>
        <label>Trapani</label>  
        <code>TP</code>  
      </i81>  
      <i82>
        <label>Trento</label>  
        <code>TN</code>  
      </i82>  
      <i83>
        <label>Treviso</label>  
        <code>TV</code>  
      </i83>  
      <i84>
        <label>Trieste</label>  
        <code>TS</code>  
      </i84>  
      <i85>
        <label>Udine</label>  
        <code>UD</code>  
      </i85>  
      <i86>
        <label>Varese</label>  
        <code>VA</code>  
      </i86>  
      <i87>
        <label>Verbano-Cusio-Ossola</label>  
        <code>VB</code>  
      </i87>  
      <i88>
        <label>Vercelli</label>  
        <code>VC</code>  
      </i88>  
      <i89>
        <label>Verona</label>  
        <code>VR</code>  
      </i89>  
      <i90>
        <label>Vibo Valentia</label>  
        <code>VV</code>  
      </i90>  
      <i91>
        <label>Vicenza</label>  
        <code>VI</code>  
      </i91>  
      <i92>
        <label>Viterbo</label>  
        <code>VT</code>  
      </i92>  
    </provinces>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/provinces/list?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_provinces_0_label=Agrigento
result_provinces_0_code=AG
result_provinces_1_label=Alessandria
result_provinces_1_code=AL
result_provinces_2_label=Ancona
result_provinces_2_code=AN
result_provinces_3_label=Aosta
result_provinces_3_code=AO
result_provinces_4_label=Arezzo
result_provinces_4_code=AR
result_provinces_5_label=Ascoli Piceno
result_provinces_5_code=AP
result_provinces_6_label=Asti
result_provinces_6_code=AT
result_provinces_7_label=Avellino
result_provinces_7_code=AV
result_provinces_8_label=Barletta-Andria-Trani
result_provinces_8_code=BT
result_provinces_9_label=Belluno
result_provinces_9_code=BL
result_provinces_10_label=Benevento
result_provinces_10_code=BN
result_provinces_11_label=Bergamo
result_provinces_11_code=BG
result_provinces_12_label=Biella
result_provinces_12_code=BI
result_provinces_13_label=Bolzano
result_provinces_13_code=BZ
result_provinces_14_label=Brescia
result_provinces_14_code=BS
result_provinces_15_label=Brindisi
result_provinces_15_code=BR
result_provinces_16_label=Caltanissetta
result_provinces_16_code=CL
result_provinces_17_label=Campobasso
result_provinces_17_code=CB
result_provinces_18_label=Caserta
result_provinces_18_code=CE
result_provinces_19_label=Catanzaro
result_provinces_19_code=CZ
result_provinces_20_label=Chieti
result_provinces_20_code=CH
result_provinces_21_label=Como
result_provinces_21_code=CO
result_provinces_22_label=Cosenza
result_provinces_22_code=CS
result_provinces_23_label=Cremona
result_provinces_23_code=CR
result_provinces_24_label=Crotone
result_provinces_24_code=KR
result_provinces_25_label=Cuneo
result_provinces_25_code=CN
result_provinces_26_label=Enna
result_provinces_26_code=EN
result_provinces_27_label=Fermo
result_provinces_27_code=FM
result_provinces_28_label=Ferrara
result_provinces_28_code=FE
result_provinces_29_label=Foggia
result_provinces_29_code=FG
result_provinces_30_label=Forl&igrave;-Cesena
result_provinces_30_code=FC
result_provinces_31_label=Frosinone
result_provinces_31_code=FR
result_provinces_32_label=Gorizia
result_provinces_32_code=GO
result_provinces_33_label=Grosseto
result_provinces_33_code=GR
result_provinces_34_label=Imperia
result_provinces_34_code=IM
result_provinces_35_label=Isernia
result_provinces_35_code=IS
result_provinces_36_label=L'Aquila
result_provinces_36_code=AQ
result_provinces_37_label=LaSpezia
result_provinces_37_code=SP
result_provinces_38_label=Latina
result_provinces_38_code=LT
result_provinces_39_label=Lecce
result_provinces_39_code=LE
result_provinces_40_label=Lecco
result_provinces_40_code=LC
result_provinces_41_label=Livorno
result_provinces_41_code=LI
result_provinces_42_label=Lodi
result_provinces_42_code=LO
result_provinces_43_label=Lucca
result_provinces_43_code=LU
result_provinces_44_label=Macerata
result_provinces_44_code=MC
result_provinces_45_label=Mantova
result_provinces_45_code=MN
result_provinces_46_label=Massa-Carrara
result_provinces_46_code=MS
result_provinces_47_label=Matera
result_provinces_47_code=MT
result_provinces_48_label=Modena
result_provinces_48_code=MO
result_provinces_49_label=Monzae Brianza
result_provinces_49_code=MB
result_provinces_50_label=Novara
result_provinces_50_code=NO
result_provinces_51_label=Nuoro
result_provinces_51_code=NU
result_provinces_52_label=Oristano
result_provinces_52_code=OR
result_provinces_53_label=Padova
result_provinces_53_code=PD
result_provinces_54_label=Parma
result_provinces_54_code=PR
result_provinces_55_label=Pavia
result_provinces_55_code=PV
result_provinces_56_label=Perugia
result_provinces_56_code=PG
result_provinces_57_label=Pesaro e Urbino
result_provinces_57_code=PU
result_provinces_58_label=Pescara
result_provinces_58_code=PE
result_provinces_59_label=Piacenza
result_provinces_59_code=PC
result_provinces_60_label=Pisa
result_provinces_60_code=PI
result_provinces_61_label=Pistoia
result_provinces_61_code=PT
result_provinces_62_label=Pordenone
result_provinces_62_code=PN
result_provinces_63_label=Potenza
result_provinces_63_code=PZ
result_provinces_64_label=Prato
result_provinces_64_code=PO
result_provinces_65_label=Ragusa
result_provinces_65_code=RG
result_provinces_66_label=Ravenna
result_provinces_66_code=RA
result_provinces_67_label=Reggio Emilia
result_provinces_67_code=RE
result_provinces_68_label=Rieti
result_provinces_68_code=RI
result_provinces_69_label=Rimini
result_provinces_69_code=RN
result_provinces_70_label=Rovigo
result_provinces_70_code=RO
result_provinces_71_label=Salerno
result_provinces_71_code=SA
result_provinces_72_label=Sassari
result_provinces_72_code=SS
result_provinces_73_label=Savona
result_provinces_73_code=SV
result_provinces_74_label=Siena
result_provinces_74_code=SI
result_provinces_75_label=Siracusa
result_provinces_75_code=SR
result_provinces_76_label=Sondrio
result_provinces_76_code=SO
result_provinces_77_label=Sud Sardegna
result_provinces_77_code=SU
result_provinces_78_label=Taranto
result_provinces_78_code=TA
result_provinces_79_label=Teramo
result_provinces_79_code=TE
result_provinces_80_label=Terni
result_provinces_80_code=TR
result_provinces_81_label=Trapani
result_provinces_81_code=TP
result_provinces_82_label=Trento
result_provinces_82_code=TN
result_provinces_83_label=Treviso
result_provinces_83_code=TV
result_provinces_84_label=Trieste
result_provinces_84_code=TS
result_provinces_85_label=Udine
result_provinces_85_code=UD
result_provinces_86_label=Varese
result_provinces_86_code=VA
result_provinces_87_label=Verbano-Cusio-Ossola
result_provinces_87_code=VB
result_provinces_88_label=Vercelli
result_provinces_88_code=VC
result_provinces_89_label=Verona
result_provinces_89_code=VR
result_provinces_90_label=Vibo Valentia
result_provinces_90_code=VV
result_provinces_91_label=Vicenza
result_provinces_91_code=VI
result_provinces_92_label=Viterbo
result_provinces_92_code=VT

Example 4 (plain)

Request

https://joturl.com/a/i1/provinces/list?format=plain

Query parameters

format = plain

Response

Agrigento
AG
Alessandria
AL
Ancona
AN
Aosta
AO
Arezzo
AR
Ascoli Piceno
AP
Asti
AT
Avellino
AV
Barletta-Andria-Trani
BT
Belluno
BL
Benevento
BN
Bergamo
BG
Biella
BI
Bolzano
BZ
Brescia
BS
Brindisi
BR
Caltanissetta
CL
Campobasso
CB
Caserta
CE
Catanzaro
CZ
Chieti
CH
Como
CO
Cosenza
CS
Cremona
CR
Crotone
KR
Cuneo
CN
Enna
EN
Fermo
FM
Ferrara
FE
Foggia
FG
Forl&igrave;-Cesena
FC
Frosinone
FR
Gorizia
GO
Grosseto
GR
Imperia
IM
Isernia
IS
L'Aquila
AQ
LaSpezia
SP
Latina
LT
Lecce
LE
Lecco
LC
Livorno
LI
Lodi
LO
Lucca
LU
Macerata
MC
Mantova
MN
Massa-Carrara
MS
Matera
MT
Modena
MO
Monzae Brianza
MB
Novara
NO
Nuoro
NU
Oristano
OR
Padova
PD
Parma
PR
Pavia
PV
Perugia
PG
Pesaro e Urbino
PU
Pescara
PE
Piacenza
PC
Pisa
PI
Pistoia
PT
Pordenone
PN
Potenza
PZ
Prato
PO
Ragusa
RG
Ravenna
RA
Reggio Emilia
RE
Rieti
RI
Rimini
RN
Rovigo
RO
Salerno
SA
Sassari
SS
Savona
SV
Siena
SI
Siracusa
SR
Sondrio
SO
Sud Sardegna
SU
Taranto
TA
Teramo
TE
Terni
TR
Trapani
TP
Trento
TN
Treviso
TV
Trieste
TS
Udine
UD
Varese
VA
Verbano-Cusio-Ossola
VB
Vercelli
VC
Verona
VR
Vibo Valentia
VV
Vicenza
VI
Viterbo
VT
Return values
parameterdescription
provinceslist of available Italian provinces

/qrcodes

/qrcodes/add

access: [WRITE]

Add a QR code template.

Example 1 (json)

Request

https://joturl.com/a/i1/qrcodes/add?name=QR+code+template&shape=square&bg_color=FFFFFF00&bg_img_id=d892f67e0c1aef0163960e0e144e0aed&bg_flip_v=0&bg_flip_h=0&bg_sslider_value=0&bg_rslider_value=0&bg_tslider_value=0&fg_color=000000FF&fg_img_id=0eb0a1c637f866c4dc46cb0f11e9f384&fg_flip_v=0&fg_flip_h=0&fg_sslider_value=72&fg_rslider_value=0&fg_tslider_value=0

Query parameters

            name = QR code template
           shape = square
        bg_color = FFFFFF00
       bg_img_id = d892f67e0c1aef0163960e0e144e0aed
       bg_flip_v = 0
       bg_flip_h = 0
bg_sslider_value = 0
bg_rslider_value = 0
bg_tslider_value = 0
        fg_color = 000000FF
       fg_img_id = 0eb0a1c637f866c4dc46cb0f11e9f384
       fg_flip_v = 0
       fg_flip_h = 0
fg_sslider_value = 72
fg_rslider_value = 0
fg_tslider_value = 0

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "df639160c18c15438054367c795117f1",
    "name": "QR code template"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/qrcodes/add?name=QR+code+template&shape=square&bg_color=FFFFFF00&bg_img_id=d892f67e0c1aef0163960e0e144e0aed&bg_flip_v=0&bg_flip_h=0&bg_sslider_value=0&bg_rslider_value=0&bg_tslider_value=0&fg_color=000000FF&fg_img_id=0eb0a1c637f866c4dc46cb0f11e9f384&fg_flip_v=0&fg_flip_h=0&fg_sslider_value=72&fg_rslider_value=0&fg_tslider_value=0&format=xml

Query parameters

            name = QR code template
           shape = square
        bg_color = FFFFFF00
       bg_img_id = d892f67e0c1aef0163960e0e144e0aed
       bg_flip_v = 0
       bg_flip_h = 0
bg_sslider_value = 0
bg_rslider_value = 0
bg_tslider_value = 0
        fg_color = 000000FF
       fg_img_id = 0eb0a1c637f866c4dc46cb0f11e9f384
       fg_flip_v = 0
       fg_flip_h = 0
fg_sslider_value = 72
fg_rslider_value = 0
fg_tslider_value = 0
          format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>df639160c18c15438054367c795117f1</id>  
    <name>QR code template</name>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/qrcodes/add?name=QR+code+template&shape=square&bg_color=FFFFFF00&bg_img_id=d892f67e0c1aef0163960e0e144e0aed&bg_flip_v=0&bg_flip_h=0&bg_sslider_value=0&bg_rslider_value=0&bg_tslider_value=0&fg_color=000000FF&fg_img_id=0eb0a1c637f866c4dc46cb0f11e9f384&fg_flip_v=0&fg_flip_h=0&fg_sslider_value=72&fg_rslider_value=0&fg_tslider_value=0&format=txt

Query parameters

            name = QR code template
           shape = square
        bg_color = FFFFFF00
       bg_img_id = d892f67e0c1aef0163960e0e144e0aed
       bg_flip_v = 0
       bg_flip_h = 0
bg_sslider_value = 0
bg_rslider_value = 0
bg_tslider_value = 0
        fg_color = 000000FF
       fg_img_id = 0eb0a1c637f866c4dc46cb0f11e9f384
       fg_flip_v = 0
       fg_flip_h = 0
fg_sslider_value = 72
fg_rslider_value = 0
fg_tslider_value = 0
          format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=df639160c18c15438054367c795117f1
result_name=QR code template

Example 4 (plain)

Request

https://joturl.com/a/i1/qrcodes/add?name=QR+code+template&shape=square&bg_color=FFFFFF00&bg_img_id=d892f67e0c1aef0163960e0e144e0aed&bg_flip_v=0&bg_flip_h=0&bg_sslider_value=0&bg_rslider_value=0&bg_tslider_value=0&fg_color=000000FF&fg_img_id=0eb0a1c637f866c4dc46cb0f11e9f384&fg_flip_v=0&fg_flip_h=0&fg_sslider_value=72&fg_rslider_value=0&fg_tslider_value=0&format=plain

Query parameters

            name = QR code template
           shape = square
        bg_color = FFFFFF00
       bg_img_id = d892f67e0c1aef0163960e0e144e0aed
       bg_flip_v = 0
       bg_flip_h = 0
bg_sslider_value = 0
bg_rslider_value = 0
bg_tslider_value = 0
        fg_color = 000000FF
       fg_img_id = 0eb0a1c637f866c4dc46cb0f11e9f384
       fg_flip_v = 0
       fg_flip_h = 0
fg_sslider_value = 72
fg_rslider_value = 0
fg_tslider_value = 0
          format = plain

Response

df639160c18c15438054367c795117f1
QR code template
Required parameters
parameterdescriptionmax length
nameSTRINGQR code template name50
Optional parameters
parameterdescription
bg_brand_idIDNA
bg_colorSTRINGSee i1/qrcodes/list for details
bg_flip_hSTRINGSee i1/qrcodes/list for details
bg_flip_vSTRINGSee i1/qrcodes/list for details
bg_img_idIDSee i1/qrcodes/list for details
bg_rslider_valueSTRINGSee i1/qrcodes/list for details
bg_sslider_valueSTRINGSee i1/qrcodes/list for details
bg_tslider_valueSTRINGSee i1/qrcodes/list for details
fg_brand_idIDNA
fg_colorSTRINGSee i1/qrcodes/list for details
fg_flip_hSTRINGSee i1/qrcodes/list for details
fg_flip_vSTRINGSee i1/qrcodes/list for details
fg_img_idIDSee i1/qrcodes/list for details
fg_rslider_valueSTRINGSee i1/qrcodes/list for details
fg_sslider_valueSTRINGSee i1/qrcodes/list for details
fg_tslider_valueSTRINGSee i1/qrcodes/list for details
shapeSTRINGSee i1/qrcodes/list for details
Return values
parameterdescription
idID of the QR code template
nameecho back of the input parameter name

/qrcodes/count

access: [READ]

This method returns the number of defined QR code templates.

Example 1 (json)

Request

https://joturl.com/a/i1/qrcodes/count?search=test

Query parameters

search = test

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 4
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/qrcodes/count?search=test&format=xml

Query parameters

search = test
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>4</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/qrcodes/count?search=test&format=txt

Query parameters

search = test
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=4

Example 4 (plain)

Request

https://joturl.com/a/i1/qrcodes/count?search=test&format=plain

Query parameters

search = test
format = plain

Response

4
Optional parameters
parameterdescription
searchSTRINGfilters QR code templates to be extracted by searching them
Return values
parameterdescription
countnumber of (filtered) QR code templates

/qrcodes/delete

access: [WRITE]

This method deletes a set of QR code templates by using their IDs.

Example 1 (json)

Request

https://joturl.com/a/i1/qrcodes/delete?ids=c8587aafe0dd19ed9b87bad8b0d2cc21,3252486882fff30660f61c01784c178a,e601ebf501035e5ee87f10bfd64a40b5

Query parameters

ids = c8587aafe0dd19ed9b87bad8b0d2cc21,3252486882fff30660f61c01784c178a,e601ebf501035e5ee87f10bfd64a40b5

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 3
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/qrcodes/delete?ids=c8587aafe0dd19ed9b87bad8b0d2cc21,3252486882fff30660f61c01784c178a,e601ebf501035e5ee87f10bfd64a40b5&format=xml

Query parameters

   ids = c8587aafe0dd19ed9b87bad8b0d2cc21,3252486882fff30660f61c01784c178a,e601ebf501035e5ee87f10bfd64a40b5
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>3</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/qrcodes/delete?ids=c8587aafe0dd19ed9b87bad8b0d2cc21,3252486882fff30660f61c01784c178a,e601ebf501035e5ee87f10bfd64a40b5&format=txt

Query parameters

   ids = c8587aafe0dd19ed9b87bad8b0d2cc21,3252486882fff30660f61c01784c178a,e601ebf501035e5ee87f10bfd64a40b5
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=3

Example 4 (plain)

Request

https://joturl.com/a/i1/qrcodes/delete?ids=c8587aafe0dd19ed9b87bad8b0d2cc21,3252486882fff30660f61c01784c178a,e601ebf501035e5ee87f10bfd64a40b5&format=plain

Query parameters

   ids = c8587aafe0dd19ed9b87bad8b0d2cc21,3252486882fff30660f61c01784c178a,e601ebf501035e5ee87f10bfd64a40b5
format = plain

Response

3

Example 5 (json)

Request

https://joturl.com/a/i1/qrcodes/delete?ids=f97d6149b1c9b6a2624d147b4100a3a8,ed3b2b962a16cb69259265abb7fbf75b,eea7254b749ddd977c870bc4fb40e260

Query parameters

ids = f97d6149b1c9b6a2624d147b4100a3a8,ed3b2b962a16cb69259265abb7fbf75b,eea7254b749ddd977c870bc4fb40e260

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "ids": "f97d6149b1c9b6a2624d147b4100a3a8,ed3b2b962a16cb69259265abb7fbf75b",
    "deleted": 1
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/qrcodes/delete?ids=f97d6149b1c9b6a2624d147b4100a3a8,ed3b2b962a16cb69259265abb7fbf75b,eea7254b749ddd977c870bc4fb40e260&format=xml

Query parameters

   ids = f97d6149b1c9b6a2624d147b4100a3a8,ed3b2b962a16cb69259265abb7fbf75b,eea7254b749ddd977c870bc4fb40e260
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <ids>f97d6149b1c9b6a2624d147b4100a3a8,ed3b2b962a16cb69259265abb7fbf75b</ids>  
    <deleted>1</deleted>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/qrcodes/delete?ids=f97d6149b1c9b6a2624d147b4100a3a8,ed3b2b962a16cb69259265abb7fbf75b,eea7254b749ddd977c870bc4fb40e260&format=txt

Query parameters

   ids = f97d6149b1c9b6a2624d147b4100a3a8,ed3b2b962a16cb69259265abb7fbf75b,eea7254b749ddd977c870bc4fb40e260
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_ids=f97d6149b1c9b6a2624d147b4100a3a8,ed3b2b962a16cb69259265abb7fbf75b
result_deleted=1

Example 8 (plain)

Request

https://joturl.com/a/i1/qrcodes/delete?ids=f97d6149b1c9b6a2624d147b4100a3a8,ed3b2b962a16cb69259265abb7fbf75b,eea7254b749ddd977c870bc4fb40e260&format=plain

Query parameters

   ids = f97d6149b1c9b6a2624d147b4100a3a8,ed3b2b962a16cb69259265abb7fbf75b,eea7254b749ddd977c870bc4fb40e260
format = plain

Response

f97d6149b1c9b6a2624d147b4100a3a8,ed3b2b962a16cb69259265abb7fbf75b
1
Required parameters
parameterdescription
idsARRAY_OF_IDScomma-separated list of QR code template IDs to be deleted
Return values
parameterdescription
deletednumber of deleted QR code templates
ids[OPTIONAL] list of QR code template IDs whose delete has failed, this parameter is returned only when at least one delete error has occurred

/qrcodes/edit

access: [WRITE]

Edit a QR code template.

Example 1 (json)

Request

https://joturl.com/a/i1/qrcodes/edit?id=ee2e344c303174438b21e0ab6af6244e&name=new+name+for+the+QR+code+template

Query parameters

  id = ee2e344c303174438b21e0ab6af6244e
name = new name for the QR code template

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "ee2e344c303174438b21e0ab6af6244e",
    "name": "new name for the QR code template"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/qrcodes/edit?id=ee2e344c303174438b21e0ab6af6244e&name=new+name+for+the+QR+code+template&format=xml

Query parameters

    id = ee2e344c303174438b21e0ab6af6244e
  name = new name for the QR code template
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>ee2e344c303174438b21e0ab6af6244e</id>  
    <name>new name for the QR code template</name>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/qrcodes/edit?id=ee2e344c303174438b21e0ab6af6244e&name=new+name+for+the+QR+code+template&format=txt

Query parameters

    id = ee2e344c303174438b21e0ab6af6244e
  name = new name for the QR code template
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=ee2e344c303174438b21e0ab6af6244e
result_name=new name for the QR code template

Example 4 (plain)

Request

https://joturl.com/a/i1/qrcodes/edit?id=ee2e344c303174438b21e0ab6af6244e&name=new+name+for+the+QR+code+template&format=plain

Query parameters

    id = ee2e344c303174438b21e0ab6af6244e
  name = new name for the QR code template
format = plain

Response

ee2e344c303174438b21e0ab6af6244e
new name for the QR code template
Required parameters
parameterdescription
idIDID of the QR code template
Optional parameters
parameterdescriptionmax length
bg_brand_idIDNA
bg_colorSTRINGSee i1/qrcodes/list for details
bg_flip_hSTRINGSee i1/qrcodes/list for details
bg_flip_vSTRINGSee i1/qrcodes/list for details
bg_img_idIDSee i1/qrcodes/list for details
bg_rslider_valueSTRINGSee i1/qrcodes/list for details
bg_sslider_valueSTRINGSee i1/qrcodes/list for details
bg_tslider_valueSTRINGSee i1/qrcodes/list for details
fg_brand_idIDNA
fg_colorSTRINGSee i1/qrcodes/list for details
fg_flip_hSTRINGSee i1/qrcodes/list for details
fg_flip_vSTRINGSee i1/qrcodes/list for details
fg_img_idIDSee i1/qrcodes/list for details
fg_rslider_valueSTRINGSee i1/qrcodes/list for details
fg_sslider_valueSTRINGSee i1/qrcodes/list for details
fg_tslider_valueSTRINGSee i1/qrcodes/list for details
nameSTRINGSee i1/qrcodes/list for details50
shapeSTRINGSee i1/qrcodes/list for details
Return values
parameterdescription
idID of the QR code template
nameecho back of the input parameter name

/qrcodes/info

access: [READ]

This method returns information specified in a comma separated input called fields about a Qr code template.

Example 1 (json)

Request

https://joturl.com/a/i1/qrcodes/info?fields=count,id,name,shape,bg_color,bg_img_id,bg_flip_v,bg_flip_h,bg_sslider_value,bg_rslider_value,bg_tslider_value,fg_color,fg_img_id,fg_flip_v,fg_flip_h,fg_sslider_value,fg_rslider_value,fg_tslider_value

Query parameters

fields = count,id,name,shape,bg_color,bg_img_id,bg_flip_v,bg_flip_h,bg_sslider_value,bg_rslider_value,bg_tslider_value,fg_color,fg_img_id,fg_flip_v,fg_flip_h,fg_sslider_value,fg_rslider_value,fg_tslider_value

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "1edc02fbd50943e2b4deda2161165fcb",
    "name": "QR code template",
    "shape": "square",
    "bg_color": "FFFFFF00",
    "bg_img_id": "009a51fe9c24e456b6c297c72c84e3db",
    "bg_flip_v": 0,
    "bg_flip_h": 0,
    "bg_sslider_value": 0,
    "bg_rslider_value": 0,
    "bg_tslider_value": 0,
    "fg_color": "000000FF",
    "fg_img_id": "addb2fae5a3566d3d179648f6491b823",
    "fg_flip_v": 0,
    "fg_flip_h": 0,
    "fg_sslider_value": 72,
    "fg_rslider_value": 0,
    "fg_tslider_value": 0
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/qrcodes/info?fields=count,id,name,shape,bg_color,bg_img_id,bg_flip_v,bg_flip_h,bg_sslider_value,bg_rslider_value,bg_tslider_value,fg_color,fg_img_id,fg_flip_v,fg_flip_h,fg_sslider_value,fg_rslider_value,fg_tslider_value&format=xml

Query parameters

fields = count,id,name,shape,bg_color,bg_img_id,bg_flip_v,bg_flip_h,bg_sslider_value,bg_rslider_value,bg_tslider_value,fg_color,fg_img_id,fg_flip_v,fg_flip_h,fg_sslider_value,fg_rslider_value,fg_tslider_value
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>1edc02fbd50943e2b4deda2161165fcb</id>  
    <name>QR code template</name>  
    <shape>square</shape>  
    <bg_color>FFFFFF00</bg_color>  
    <bg_img_id>009a51fe9c24e456b6c297c72c84e3db</bg_img_id>  
    <bg_flip_v>0</bg_flip_v>  
    <bg_flip_h>0</bg_flip_h>  
    <bg_sslider_value>0</bg_sslider_value>  
    <bg_rslider_value>0</bg_rslider_value>  
    <bg_tslider_value>0</bg_tslider_value>  
    <fg_color>000000FF</fg_color>  
    <fg_img_id>addb2fae5a3566d3d179648f6491b823</fg_img_id>  
    <fg_flip_v>0</fg_flip_v>  
    <fg_flip_h>0</fg_flip_h>  
    <fg_sslider_value>72</fg_sslider_value>  
    <fg_rslider_value>0</fg_rslider_value>  
    <fg_tslider_value>0</fg_tslider_value>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/qrcodes/info?fields=count,id,name,shape,bg_color,bg_img_id,bg_flip_v,bg_flip_h,bg_sslider_value,bg_rslider_value,bg_tslider_value,fg_color,fg_img_id,fg_flip_v,fg_flip_h,fg_sslider_value,fg_rslider_value,fg_tslider_value&format=txt

Query parameters

fields = count,id,name,shape,bg_color,bg_img_id,bg_flip_v,bg_flip_h,bg_sslider_value,bg_rslider_value,bg_tslider_value,fg_color,fg_img_id,fg_flip_v,fg_flip_h,fg_sslider_value,fg_rslider_value,fg_tslider_value
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=1edc02fbd50943e2b4deda2161165fcb
result_name=QR code template
result_shape=square
result_bg_color=FFFFFF00
result_bg_img_id=009a51fe9c24e456b6c297c72c84e3db
result_bg_flip_v=0
result_bg_flip_h=0
result_bg_sslider_value=0
result_bg_rslider_value=0
result_bg_tslider_value=0
result_fg_color=000000FF
result_fg_img_id=addb2fae5a3566d3d179648f6491b823
result_fg_flip_v=0
result_fg_flip_h=0
result_fg_sslider_value=72
result_fg_rslider_value=0
result_fg_tslider_value=0

Example 4 (plain)

Request

https://joturl.com/a/i1/qrcodes/info?fields=count,id,name,shape,bg_color,bg_img_id,bg_flip_v,bg_flip_h,bg_sslider_value,bg_rslider_value,bg_tslider_value,fg_color,fg_img_id,fg_flip_v,fg_flip_h,fg_sslider_value,fg_rslider_value,fg_tslider_value&format=plain

Query parameters

fields = count,id,name,shape,bg_color,bg_img_id,bg_flip_v,bg_flip_h,bg_sslider_value,bg_rslider_value,bg_tslider_value,fg_color,fg_img_id,fg_flip_v,fg_flip_h,fg_sslider_value,fg_rslider_value,fg_tslider_value
format = plain

Response

1edc02fbd50943e2b4deda2161165fcb
QR code template
square
FFFFFF00
009a51fe9c24e456b6c297c72c84e3db
0
0
0
0
0
000000FF
addb2fae5a3566d3d179648f6491b823
0
0
72
0
0
Required parameters
parameterdescription
fieldsARRAYcomma-separated list of fields to return, see i1/qrcodes/list for details
idIDID of the QR code template
Return values
parameterdescription
bg_color[OPTIONAL] returned only if bg_color is passed in fields
bg_flip_h[OPTIONAL] returned only if bg_flip_h is passed in fields
bg_flip_v[OPTIONAL] returned only if bg_flip_v is passed in fields
bg_img_id[OPTIONAL] returned only if bg_img_id is passed in fields
bg_rslider_value[OPTIONAL] returned only if bg_rslider_value is passed in fields
bg_sslider_value[OPTIONAL] returned only if bg_sslider_value is passed in fields
bg_tslider_value[OPTIONAL] returned only if bg_tslider_value is passed in fields
fg_color[OPTIONAL] returned only if fg_color is passed in fields
fg_flip_h[OPTIONAL] returned only if fg_flip_h is passed in fields
fg_flip_v[OPTIONAL] returned only if fg_flip_v is passed in fields
fg_img_id[OPTIONAL] returned only if fg_img_id is passed in fields
fg_rslider_value[OPTIONAL] returned only if fg_rslider_value is passed in fields
fg_sslider_value[OPTIONAL] returned only if fg_sslider_value is passed in fields
fg_tslider_value[OPTIONAL] returned only if fg_tslider_value is passed in fields
id[OPTIONAL] returned only if id is passed in fields
name[OPTIONAL] returned only if name is passed in fields
shape[OPTIONAL] returned only if shape is passed in fields

/qrcodes/list

access: [READ]

This method returns a list of user's Qr code templates, specified in a comma separated input called fields.

Example 1 (json)

Request

https://joturl.com/a/i1/qrcodes/list?fields=count,id,name,shape,bg_color,bg_img_id,bg_flip_v,bg_flip_h,bg_sslider_value,bg_rslider_value,bg_tslider_value,fg_color,fg_img_id,fg_flip_v,fg_flip_h,fg_sslider_value,fg_rslider_value,fg_tslider_value

Query parameters

fields = count,id,name,shape,bg_color,bg_img_id,bg_flip_v,bg_flip_h,bg_sslider_value,bg_rslider_value,bg_tslider_value,fg_color,fg_img_id,fg_flip_v,fg_flip_h,fg_sslider_value,fg_rslider_value,fg_tslider_value

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 1,
    "data": [
      {
        "id": "354a2dc692eeb4e77ce9c6ffb912ce33",
        "name": "QR code template",
        "shape": "square",
        "bg_color": "FFFFFF00",
        "bg_img_id": "badab28299f5e42b750b81d211ea7e79",
        "bg_flip_v": 0,
        "bg_flip_h": 0,
        "bg_sslider_value": 0,
        "bg_rslider_value": 0,
        "bg_tslider_value": 0,
        "fg_color": "000000FF",
        "fg_img_id": "2bbbb46fcacbd581fae05afabc3f0bfe",
        "fg_flip_v": 0,
        "fg_flip_h": 0,
        "fg_sslider_value": 72,
        "fg_rslider_value": 0,
        "fg_tslider_value": 0
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/qrcodes/list?fields=count,id,name,shape,bg_color,bg_img_id,bg_flip_v,bg_flip_h,bg_sslider_value,bg_rslider_value,bg_tslider_value,fg_color,fg_img_id,fg_flip_v,fg_flip_h,fg_sslider_value,fg_rslider_value,fg_tslider_value&format=xml

Query parameters

fields = count,id,name,shape,bg_color,bg_img_id,bg_flip_v,bg_flip_h,bg_sslider_value,bg_rslider_value,bg_tslider_value,fg_color,fg_img_id,fg_flip_v,fg_flip_h,fg_sslider_value,fg_rslider_value,fg_tslider_value
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>1</count>  
    <data>
      <i0>
        <id>354a2dc692eeb4e77ce9c6ffb912ce33</id>  
        <name>QR code template</name>  
        <shape>square</shape>  
        <bg_color>FFFFFF00</bg_color>  
        <bg_img_id>badab28299f5e42b750b81d211ea7e79</bg_img_id>  
        <bg_flip_v>0</bg_flip_v>  
        <bg_flip_h>0</bg_flip_h>  
        <bg_sslider_value>0</bg_sslider_value>  
        <bg_rslider_value>0</bg_rslider_value>  
        <bg_tslider_value>0</bg_tslider_value>  
        <fg_color>000000FF</fg_color>  
        <fg_img_id>2bbbb46fcacbd581fae05afabc3f0bfe</fg_img_id>  
        <fg_flip_v>0</fg_flip_v>  
        <fg_flip_h>0</fg_flip_h>  
        <fg_sslider_value>72</fg_sslider_value>  
        <fg_rslider_value>0</fg_rslider_value>  
        <fg_tslider_value>0</fg_tslider_value>  
      </i0>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/qrcodes/list?fields=count,id,name,shape,bg_color,bg_img_id,bg_flip_v,bg_flip_h,bg_sslider_value,bg_rslider_value,bg_tslider_value,fg_color,fg_img_id,fg_flip_v,fg_flip_h,fg_sslider_value,fg_rslider_value,fg_tslider_value&format=txt

Query parameters

fields = count,id,name,shape,bg_color,bg_img_id,bg_flip_v,bg_flip_h,bg_sslider_value,bg_rslider_value,bg_tslider_value,fg_color,fg_img_id,fg_flip_v,fg_flip_h,fg_sslider_value,fg_rslider_value,fg_tslider_value
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=1
result_data_0_id=354a2dc692eeb4e77ce9c6ffb912ce33
result_data_0_name=QR code template
result_data_0_shape=square
result_data_0_bg_color=FFFFFF00
result_data_0_bg_img_id=badab28299f5e42b750b81d211ea7e79
result_data_0_bg_flip_v=0
result_data_0_bg_flip_h=0
result_data_0_bg_sslider_value=0
result_data_0_bg_rslider_value=0
result_data_0_bg_tslider_value=0
result_data_0_fg_color=000000FF
result_data_0_fg_img_id=2bbbb46fcacbd581fae05afabc3f0bfe
result_data_0_fg_flip_v=0
result_data_0_fg_flip_h=0
result_data_0_fg_sslider_value=72
result_data_0_fg_rslider_value=0
result_data_0_fg_tslider_value=0

Example 4 (plain)

Request

https://joturl.com/a/i1/qrcodes/list?fields=count,id,name,shape,bg_color,bg_img_id,bg_flip_v,bg_flip_h,bg_sslider_value,bg_rslider_value,bg_tslider_value,fg_color,fg_img_id,fg_flip_v,fg_flip_h,fg_sslider_value,fg_rslider_value,fg_tslider_value&format=plain

Query parameters

fields = count,id,name,shape,bg_color,bg_img_id,bg_flip_v,bg_flip_h,bg_sslider_value,bg_rslider_value,bg_tslider_value,fg_color,fg_img_id,fg_flip_v,fg_flip_h,fg_sslider_value,fg_rslider_value,fg_tslider_value
format = plain

Response

1
354a2dc692eeb4e77ce9c6ffb912ce33
QR code template
square
FFFFFF00
badab28299f5e42b750b81d211ea7e79
0
0
0
0
0
000000FF
2bbbb46fcacbd581fae05afabc3f0bfe
0
0
72
0
0
Required parameters
parameterdescription
fieldsARRAYcomma-separated list of fields to return, available fields: count, bg_color, bg_img_id, fg_color, id, fg_img_id, params, name, shape
Optional parameters
parameterdescription
lengthINTEGERextracts this number of QR code templates (maxmimum allowed: 100)
orderbyARRAYorders QR code templates by field, available fields: bg_color, bg_img_id, fg_color, id, fg_img_id, params, name, shape
searchSTRINGfilters QR code templates to be extracted by searching them
sortSTRINGsorts QR code templates in ascending (ASC) or descending (DESC) order
startINTEGERstarts to extract QR code templates from this position
typesSTRINGNA
Return values
parameterdescription
dataarray containing information on the QR code templates, returned information depends on the fields parameter.

/qrcodes/preview

access: [READ]

This method returns a preview of a QR codes.

Example 1 (json)

Request

https://joturl.com/a/i1/qrcodes/preview?size=big&id=41291142943b8d8d74ff6540249a8aab

Query parameters

size = big
  id = 41291142943b8d8d74ff6540249a8aab

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "img": "data:image\/png;base64,MDgwN2UwNTcxNjRmNGQ4NmNiMDcwYTcwYmFjNTE4ZTc="
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/qrcodes/preview?size=big&id=41291142943b8d8d74ff6540249a8aab&format=xml

Query parameters

  size = big
    id = 41291142943b8d8d74ff6540249a8aab
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <img>data:image/png;base64,MDgwN2UwNTcxNjRmNGQ4NmNiMDcwYTcwYmFjNTE4ZTc=</img>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/qrcodes/preview?size=big&id=41291142943b8d8d74ff6540249a8aab&format=txt

Query parameters

  size = big
    id = 41291142943b8d8d74ff6540249a8aab
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_img=data:image/png;base64,MDgwN2UwNTcxNjRmNGQ4NmNiMDcwYTcwYmFjNTE4ZTc=

Example 4 (plain)

Request

https://joturl.com/a/i1/qrcodes/preview?size=big&id=41291142943b8d8d74ff6540249a8aab&format=plain

Query parameters

  size = big
    id = 41291142943b8d8d74ff6540249a8aab
format = plain

Response

data:image/png;base64,MDgwN2UwNTcxNjRmNGQ4NmNiMDcwYTcwYmFjNTE4ZTc=
Optional parameters
parameterdescription
bg_brand_idIDNA
bg_colorSTRINGQR code background color, see i1/qrcodes/list for details, this parameter is ignored if id is passed
bg_flip_hSTRING1 if the background image is flipped horizontally
bg_flip_vSTRING1 if the background image is flipped vertically
bg_img_idIDID of the background image, see i1/qrcodes/list for details, this parameter is ignored if id is passed
bg_rslider_valueSTRINGbackground image rotation [0-359 deg]
bg_sslider_valueSTRINGbackground image scale [0-100%]
bg_tslider_valueSTRINGbackground image transparency [0=totally opaque - 100=totally transparent]
checkBOOLEAN1 to check if the QR code is readable, default value check = 0
customizationBOOLEAN1 if the QR code preview should be generated using bg_color, fg_color, shape, fg_img_id, bg_img_id, bg_flip_v, bg_flip_h, bg_sslider_value, bg_rslider_value, bg_tslider_value, fg_flip_v, fg_flip_h, fg_sslider_value, fg_rslider_value, fg_tslider_value; this parameter is ignored if id is passed
downloadBOOLEAN1 to force the download of the QR code to be started by this method, default value download = 0
fg_brand_idIDNA
fg_colorSTRINGQR code modules color, see i1/qrcodes/list for details, this parameter is ignored if id is passed
fg_flip_hSTRING1 if the foreground image is flipped horizontally
fg_flip_vSTRING1 if the foreground image is flipped vertically
fg_img_idIDID of the foreground image (logo), see i1/qrcodes/list for details, this parameter is ignored if id is passed
fg_rslider_valueSTRINGforeground image rotation [0-359 deg]
fg_sslider_valueSTRINGforeground image scale [0-100%]
fg_tslider_valueSTRINGforeground image transparency [0=totally opaque - 100=totally transparent]
idIDID of the QR code template to use for the preview
return_imageBOOLEAN1 to return the QR code binary data regardless the format input parameter, it is useful to show QR codes on the user interface, default value return_image = 0
shapeSTRINGQR code module shape, see i1/qrcodes/list for details, this parameter is ignored if id is passed
sizeSTRINGsize for the preview to be generated, see i1/qrcodes/property for available sizes, default value type = small
typeSTRINGimage type for the preview to be generated, see i1/qrcodes/property for available types, default value type = png
urlURLURL to which the QR code points, default value: http://joturl.com
Return values
parameterdescription
[BINARY DATA][OPTIONAL] binary data representing the QR code image are returned only if download = 1 or return_image = 1
check[OPTIONAL] 1 if the QR code is readable, 0 otherwise, returned only if check = 1, download = 0 and return_image = 0
check_hint[OPTIONAL] 0 if the QR is not readable, 1 if the QR code is readable, 2 or higher if the QR might be difficult to read, the higher the number returned in this parameter, the more difficult the QR code is to read; returned only if check = 1, download = 0 and return_image = 0
img[OPTIONAL] base64 of the data representing the QR code image, returned only if download = 0 and return_image = 0

/qrcodes/property

access: [READ]

This method returns a list of property of QR codes.

Example 1 (json)

Request

https://joturl.com/a/i1/qrcodes/property

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "shapes": [
      "square",
      "rsquare",
      "rrsquare",
      "rhombus",
      "ldiamond",
      "rdiamond",
      "dot",
      "rndsquare"
    ],
    "types": [
      "svg",
      "jpg"
    ],
    "sizes": [
      "small",
      "medium",
      "big"
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/qrcodes/property?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <shapes>
      <i0>square</i0>  
      <i1>rsquare</i1>  
      <i2>rrsquare</i2>  
      <i3>rhombus</i3>  
      <i4>ldiamond</i4>  
      <i5>rdiamond</i5>  
      <i6>dot</i6>  
      <i7>rndsquare</i7>  
    </shapes>  
    <types>
      <i0>svg</i0>  
      <i1>jpg</i1>  
    </types>  
    <sizes>
      <i0>small</i0>  
      <i1>medium</i1>  
      <i2>big</i2>  
    </sizes>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/qrcodes/property?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_shapes_0=square
result_shapes_1=rsquare
result_shapes_2=rrsquare
result_shapes_3=rhombus
result_shapes_4=ldiamond
result_shapes_5=rdiamond
result_shapes_6=dot
result_shapes_7=rndsquare
result_types_0=svg
result_types_1=jpg
result_sizes_0=small
result_sizes_1=medium
result_sizes_2=big

Example 4 (plain)

Request

https://joturl.com/a/i1/qrcodes/property?format=plain

Query parameters

format = plain

Response

square
rsquare
rrsquare
rhombus
ldiamond
rdiamond
dot
rndsquare
svg
jpg
small
medium
big
Return values
parameterdescription
shapesavailable shapes for the QR code modules
sizesavailable sizes for the QR code
typesavailable image types for the QR code

/qrcodes/urls

/qrcodes/urls/count

access: [READ]

This method returns the number of tracking link associated to a specific QR code template.

Example 1 (json)

Request

https://joturl.com/a/i1/qrcodes/urls/count?qrcode_id=91e0c851a29eb0ccf50f145fa0e60db0

Query parameters

qrcode_id = 91e0c851a29eb0ccf50f145fa0e60db0

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 9
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/qrcodes/urls/count?qrcode_id=91e0c851a29eb0ccf50f145fa0e60db0&format=xml

Query parameters

qrcode_id = 91e0c851a29eb0ccf50f145fa0e60db0
   format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>9</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/qrcodes/urls/count?qrcode_id=91e0c851a29eb0ccf50f145fa0e60db0&format=txt

Query parameters

qrcode_id = 91e0c851a29eb0ccf50f145fa0e60db0
   format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=9

Example 4 (plain)

Request

https://joturl.com/a/i1/qrcodes/urls/count?qrcode_id=91e0c851a29eb0ccf50f145fa0e60db0&format=plain

Query parameters

qrcode_id = 91e0c851a29eb0ccf50f145fa0e60db0
   format = plain

Response

9
Required parameters
parameterdescription
qrcode_idIDID of the QR code template
Optional parameters
parameterdescription
searchSTRINGfilters tracking links to be extracted by searching them
Return values
parameterdescription
countnumber of (filtered) tracking links associated to the QR code template

/qrcodes/urls/list

access: [READ]

This method returns a list of tracking link associated to a specific QR code template.

Example 1 (json)

Request

https://joturl.com/a/i1/qrcodes/urls/list?fields=id,short_url&qrcode_id=bafa057b277bf19075a410e237729aa0

Query parameters

   fields = id,short_url
qrcode_id = bafa057b277bf19075a410e237729aa0

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": [
      {
        "id": "c809d482521fae6c2178e184632b8da9",
        "short_url": "http:\/\/jo.my\/513f324a"
      },
      {
        "id": "6b187325dd8849b5884ab4bb4f330d61",
        "short_url": "http:\/\/jo.my\/a42678a9"
      },
      {
        "id": "d62eba4f808d95264d7615a2a1dcf050",
        "short_url": "http:\/\/jo.my\/1f0cf2c6"
      },
      {
        "id": "89e73a1e1c087eda88c37554bee932a4",
        "short_url": "http:\/\/jo.my\/4fab2541"
      },
      {
        "id": "c53a78b3d4ebc5c5e991a44e5d183313",
        "short_url": "http:\/\/jo.my\/1de03f38"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/qrcodes/urls/list?fields=id,short_url&qrcode_id=bafa057b277bf19075a410e237729aa0&format=xml

Query parameters

   fields = id,short_url
qrcode_id = bafa057b277bf19075a410e237729aa0
   format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <i0>
        <id>c809d482521fae6c2178e184632b8da9</id>  
        <short_url>http://jo.my/513f324a</short_url>  
      </i0>  
      <i1>
        <id>6b187325dd8849b5884ab4bb4f330d61</id>  
        <short_url>http://jo.my/a42678a9</short_url>  
      </i1>  
      <i2>
        <id>d62eba4f808d95264d7615a2a1dcf050</id>  
        <short_url>http://jo.my/1f0cf2c6</short_url>  
      </i2>  
      <i3>
        <id>89e73a1e1c087eda88c37554bee932a4</id>  
        <short_url>http://jo.my/4fab2541</short_url>  
      </i3>  
      <i4>
        <id>c53a78b3d4ebc5c5e991a44e5d183313</id>  
        <short_url>http://jo.my/1de03f38</short_url>  
      </i4>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/qrcodes/urls/list?fields=id,short_url&qrcode_id=bafa057b277bf19075a410e237729aa0&format=txt

Query parameters

   fields = id,short_url
qrcode_id = bafa057b277bf19075a410e237729aa0
   format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_0_id=c809d482521fae6c2178e184632b8da9
result_data_0_short_url=http://jo.my/513f324a
result_data_1_id=6b187325dd8849b5884ab4bb4f330d61
result_data_1_short_url=http://jo.my/a42678a9
result_data_2_id=d62eba4f808d95264d7615a2a1dcf050
result_data_2_short_url=http://jo.my/1f0cf2c6
result_data_3_id=89e73a1e1c087eda88c37554bee932a4
result_data_3_short_url=http://jo.my/4fab2541
result_data_4_id=c53a78b3d4ebc5c5e991a44e5d183313
result_data_4_short_url=http://jo.my/1de03f38

Example 4 (plain)

Request

https://joturl.com/a/i1/qrcodes/urls/list?fields=id,short_url&qrcode_id=bafa057b277bf19075a410e237729aa0&format=plain

Query parameters

   fields = id,short_url
qrcode_id = bafa057b277bf19075a410e237729aa0
   format = plain

Response

http://jo.my/513f324a
http://jo.my/a42678a9
http://jo.my/1f0cf2c6
http://jo.my/4fab2541
http://jo.my/1de03f38
Required parameters
parameterdescription
fieldsARRAYcomma separated list of fields to return, available fields: id, notes, short_url, long_url, project_id, project_name, domain_id, domain_host, count
qrcode_idIDID of the QR code template
Optional parameters
parameterdescription
lengthINTEGERextracts this number of tracking links (maxmimum allowed: 100)
orderbyARRAYorders tracking links by field, available fields: id, notes, short_url, long_url, project_id, project_name, domain_id, domain_host, count
searchSTRINGfilters tracking links to be extracted by searching them
sortSTRINGsorts tracking links in ascending (ASC) or descending (DESC) order
startINTEGERstarts to extract tracking links from this position
Return values
parameterdescription
dataarray containing information on the tracking links, the returned information depends on the fields parameter.

/remarketings

/remarketings/add

access: [WRITE]

Add a remarketing pixel for the user logged in.

Example 1 (json)

Request

https://joturl.com/a/i1/remarketings/add?name=FB+remarketing+pixel¬es=this+is+a+simple+note&code_type=facebook&code_id=132434&code_html=&gdpr_id=7522395a6a22633061376e672161356b3153613638213d3d&gdpr_enabled=2

Query parameters

        name = FB remarketing pixel
       notes = this is a simple note
   code_type = facebook
     code_id = 132434
   code_html = 
     gdpr_id = 7522395a6a22633061376e672161356b3153613638213d3d
gdpr_enabled = 2

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "71636c766251733639686861436d496d58426c464f773d3d",
    "name": "FB remarketing pixel",
    "notes": "this is a simple note",
    "code_type": "facebook",
    "code_id": "132434",
    "code_html": "",
    "gdpr_id": "7522395a6a22633061376e672161356b3153613638213d3d",
    "gdpr_enabled": 2
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/remarketings/add?name=FB+remarketing+pixel¬es=this+is+a+simple+note&code_type=facebook&code_id=132434&code_html=&gdpr_id=7522395a6a22633061376e672161356b3153613638213d3d&gdpr_enabled=2&format=xml

Query parameters

        name = FB remarketing pixel
       notes = this is a simple note
   code_type = facebook
     code_id = 132434
   code_html = 
     gdpr_id = 7522395a6a22633061376e672161356b3153613638213d3d
gdpr_enabled = 2
      format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>71636c766251733639686861436d496d58426c464f773d3d</id>  
    <name>FB remarketing pixel</name>  
    <notes>this is a simple note</notes>  
    <code_type>facebook</code_type>  
    <code_id>132434</code_id>  
    <code_html></code_html>  
    <gdpr_id>7522395a6a22633061376e672161356b3153613638213d3d</gdpr_id>  
    <gdpr_enabled>2</gdpr_enabled>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/remarketings/add?name=FB+remarketing+pixel¬es=this+is+a+simple+note&code_type=facebook&code_id=132434&code_html=&gdpr_id=7522395a6a22633061376e672161356b3153613638213d3d&gdpr_enabled=2&format=txt

Query parameters

        name = FB remarketing pixel
       notes = this is a simple note
   code_type = facebook
     code_id = 132434
   code_html = 
     gdpr_id = 7522395a6a22633061376e672161356b3153613638213d3d
gdpr_enabled = 2
      format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=71636c766251733639686861436d496d58426c464f773d3d
result_name=FB remarketing pixel
result_notes=this is a simple note
result_code_type=facebook
result_code_id=132434
result_code_html=
result_gdpr_id=7522395a6a22633061376e672161356b3153613638213d3d
result_gdpr_enabled=2

Example 4 (plain)

Request

https://joturl.com/a/i1/remarketings/add?name=FB+remarketing+pixel¬es=this+is+a+simple+note&code_type=facebook&code_id=132434&code_html=&gdpr_id=7522395a6a22633061376e672161356b3153613638213d3d&gdpr_enabled=2&format=plain

Query parameters

        name = FB remarketing pixel
       notes = this is a simple note
   code_type = facebook
     code_id = 132434
   code_html = 
     gdpr_id = 7522395a6a22633061376e672161356b3153613638213d3d
gdpr_enabled = 2
      format = plain

Response

71636c766251733639686861436d496d58426c464f773d3d
FB remarketing pixel
this is a simple note
facebook
132434

7522395a6a22633061376e672161356b3153613638213d3d
2
Required parameters
parameterdescriptionmax length
nameSTRINGremarketing pixel name100
Optional parameters
parameterdescriptionmax length
code_htmlHTMLHTML code for custom remarketing script4000
code_idSTRINGpixel ID255
code_typeENUMpixel type, available codes: adroll, bing, custom, facebook, google_adwords, google_analytics, google_tag_manager, linkedin, manychat, pinterest, quora, reddit, snapchat, tiktok, twitter
gdpr_enabledINTEGER0 if GDPR is disabled, 1 if GDPR is enabled and the default model is used, 2 if GDPR is enabled and the model with ID gdpr_id is used
gdpr_idIDID of the GDPR template associated with this remarketing pixel
notesSTRINGremarketing pixel notes128
Return values
parameterdescription
code_html[OPTIONAL] HTML code for custom remarketing script, returned only if code_html is passed
code_id[OPTIONAL] pixel ID, returned only if code_id is passed
code_type[OPTIONAL] pixel type, available codes: adroll, bing, custom, facebook, google_adwords, google_analytics, google_tag_manager, linkedin, manychat, pinterest, quora, reddit, snapchat, tiktok, twitter, returned only if code_type is passed
gdpr_enabled[OPTIONAL] 0 if GDPR is disabled, 1 if GDPR is enabled and the default model is used, 2 if GDPR is enabled and the model with ID gdpr_id is used, returned only if gdpr_enabled is passed
gdpr_id[OPTIONAL] ID of the GDPR template associated with this remarketing pixel, returned only if gdpr_id is passed
id[OPTIONAL] remarketing pixel (internal) ID, returned only if id is passed
name[OPTIONAL] remarketing pixel name, returned only if name is passed

/remarketings/count

access: [READ]

This method returns the number of defined remarketing pixels.

Example 1 (json)

Request

https://joturl.com/a/i1/remarketings/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 8
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/remarketings/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>8</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/remarketings/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=8

Example 4 (plain)

Request

https://joturl.com/a/i1/remarketings/count?format=plain

Query parameters

format = plain

Response

8

Example 5 (json)

Request

https://joturl.com/a/i1/remarketings/count?search=test

Query parameters

search = test

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 3
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/remarketings/count?search=test&format=xml

Query parameters

search = test
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>3</count>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/remarketings/count?search=test&format=txt

Query parameters

search = test
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=3

Example 8 (plain)

Request

https://joturl.com/a/i1/remarketings/count?search=test&format=plain

Query parameters

search = test
format = plain

Response

3
Optional parameters
parameterdescription
searchSTRINGcount items by searching them
typesARRAYfilters list by code type(s), it can be empty, all or a comma separated list of these codes: facebook, twitter, linkedin, pinterest, bing, google_analytics, google_adwords, google_tag_manager, manychat, quora, adroll, snapchat, tiktok, reddit, custom
Return values
parameterdescription
countnumber of remarketing pixels (filtered by search if passed)

/remarketings/delete

access: [WRITE]

This method deletes a set of remarketing pixels by using their IDs.

Example 1 (json)

Request

https://joturl.com/a/i1/remarketings/delete?ids=2aec7a2f7c02d3bd7b5cfad8179b42c7,6f7040be03a8c44dbe1a3bf7c41186f6,501f087276fbc2973e0ee87285f4bc8a

Query parameters

ids = 2aec7a2f7c02d3bd7b5cfad8179b42c7,6f7040be03a8c44dbe1a3bf7c41186f6,501f087276fbc2973e0ee87285f4bc8a

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 3
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/remarketings/delete?ids=2aec7a2f7c02d3bd7b5cfad8179b42c7,6f7040be03a8c44dbe1a3bf7c41186f6,501f087276fbc2973e0ee87285f4bc8a&format=xml

Query parameters

   ids = 2aec7a2f7c02d3bd7b5cfad8179b42c7,6f7040be03a8c44dbe1a3bf7c41186f6,501f087276fbc2973e0ee87285f4bc8a
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>3</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/remarketings/delete?ids=2aec7a2f7c02d3bd7b5cfad8179b42c7,6f7040be03a8c44dbe1a3bf7c41186f6,501f087276fbc2973e0ee87285f4bc8a&format=txt

Query parameters

   ids = 2aec7a2f7c02d3bd7b5cfad8179b42c7,6f7040be03a8c44dbe1a3bf7c41186f6,501f087276fbc2973e0ee87285f4bc8a
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=3

Example 4 (plain)

Request

https://joturl.com/a/i1/remarketings/delete?ids=2aec7a2f7c02d3bd7b5cfad8179b42c7,6f7040be03a8c44dbe1a3bf7c41186f6,501f087276fbc2973e0ee87285f4bc8a&format=plain

Query parameters

   ids = 2aec7a2f7c02d3bd7b5cfad8179b42c7,6f7040be03a8c44dbe1a3bf7c41186f6,501f087276fbc2973e0ee87285f4bc8a
format = plain

Response

3

Example 5 (json)

Request

https://joturl.com/a/i1/remarketings/delete?ids=bfe5c7d75fe8a79327330e85ba98cb43,e72f449d8a733c9bc93e250fca47b911,07ab58f1a62ce90a7ff3b24f5aac8921

Query parameters

ids = bfe5c7d75fe8a79327330e85ba98cb43,e72f449d8a733c9bc93e250fca47b911,07ab58f1a62ce90a7ff3b24f5aac8921

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "ids": "bfe5c7d75fe8a79327330e85ba98cb43,e72f449d8a733c9bc93e250fca47b911",
    "deleted": 1
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/remarketings/delete?ids=bfe5c7d75fe8a79327330e85ba98cb43,e72f449d8a733c9bc93e250fca47b911,07ab58f1a62ce90a7ff3b24f5aac8921&format=xml

Query parameters

   ids = bfe5c7d75fe8a79327330e85ba98cb43,e72f449d8a733c9bc93e250fca47b911,07ab58f1a62ce90a7ff3b24f5aac8921
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <ids>bfe5c7d75fe8a79327330e85ba98cb43,e72f449d8a733c9bc93e250fca47b911</ids>  
    <deleted>1</deleted>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/remarketings/delete?ids=bfe5c7d75fe8a79327330e85ba98cb43,e72f449d8a733c9bc93e250fca47b911,07ab58f1a62ce90a7ff3b24f5aac8921&format=txt

Query parameters

   ids = bfe5c7d75fe8a79327330e85ba98cb43,e72f449d8a733c9bc93e250fca47b911,07ab58f1a62ce90a7ff3b24f5aac8921
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_ids=bfe5c7d75fe8a79327330e85ba98cb43,e72f449d8a733c9bc93e250fca47b911
result_deleted=1

Example 8 (plain)

Request

https://joturl.com/a/i1/remarketings/delete?ids=bfe5c7d75fe8a79327330e85ba98cb43,e72f449d8a733c9bc93e250fca47b911,07ab58f1a62ce90a7ff3b24f5aac8921&format=plain

Query parameters

   ids = bfe5c7d75fe8a79327330e85ba98cb43,e72f449d8a733c9bc93e250fca47b911,07ab58f1a62ce90a7ff3b24f5aac8921
format = plain

Response

bfe5c7d75fe8a79327330e85ba98cb43,e72f449d8a733c9bc93e250fca47b911
1
Required parameters
parameterdescription
idsARRAY_OF_IDScomma-separated list of remarketing pixel IDs to be deleted
Return values
parameterdescription
deletednumber of deleted remarketing pixels
ids[OPTIONAL] list of remarketing pixel IDs whose delete has failed, this parameter is returned only when at least one delete error has occurred

/remarketings/edit

access: [WRITE]

Edit fields of a remarketing pixel.

Example 1 (json)

Request

https://joturl.com/a/i1/remarketings/edit?id=306663506735386e622f69266e366a586d6b722552513d3d&name=FB+remarketing+pixel¬es=this+is+a+simple+note&code_type=facebook&code_id=132434&code_html=&gdpr_id=7522395a6a22633061376e672161356b3153613638213d3d&gdpr_enabled=2

Query parameters

          id = 306663506735386e622f69266e366a586d6b722552513d3d
        name = FB remarketing pixel
       notes = this is a simple note
   code_type = facebook
     code_id = 132434
   code_html = 
     gdpr_id = 7522395a6a22633061376e672161356b3153613638213d3d
gdpr_enabled = 2

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "306663506735386e622f69266e366a586d6b722552513d3d",
    "name": "FB remarketing pixel",
    "notes": "this is a simple note",
    "code_type": "facebook",
    "code_id": "132434",
    "code_html": "",
    "gdpr_id": "7522395a6a22633061376e672161356b3153613638213d3d",
    "gdpr_enabled": 2
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/remarketings/edit?id=306663506735386e622f69266e366a586d6b722552513d3d&name=FB+remarketing+pixel¬es=this+is+a+simple+note&code_type=facebook&code_id=132434&code_html=&gdpr_id=7522395a6a22633061376e672161356b3153613638213d3d&gdpr_enabled=2&format=xml

Query parameters

          id = 306663506735386e622f69266e366a586d6b722552513d3d
        name = FB remarketing pixel
       notes = this is a simple note
   code_type = facebook
     code_id = 132434
   code_html = 
     gdpr_id = 7522395a6a22633061376e672161356b3153613638213d3d
gdpr_enabled = 2
      format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>306663506735386e622f69266e366a586d6b722552513d3d</id>  
    <name>FB remarketing pixel</name>  
    <notes>this is a simple note</notes>  
    <code_type>facebook</code_type>  
    <code_id>132434</code_id>  
    <code_html></code_html>  
    <gdpr_id>7522395a6a22633061376e672161356b3153613638213d3d</gdpr_id>  
    <gdpr_enabled>2</gdpr_enabled>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/remarketings/edit?id=306663506735386e622f69266e366a586d6b722552513d3d&name=FB+remarketing+pixel¬es=this+is+a+simple+note&code_type=facebook&code_id=132434&code_html=&gdpr_id=7522395a6a22633061376e672161356b3153613638213d3d&gdpr_enabled=2&format=txt

Query parameters

          id = 306663506735386e622f69266e366a586d6b722552513d3d
        name = FB remarketing pixel
       notes = this is a simple note
   code_type = facebook
     code_id = 132434
   code_html = 
     gdpr_id = 7522395a6a22633061376e672161356b3153613638213d3d
gdpr_enabled = 2
      format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=306663506735386e622f69266e366a586d6b722552513d3d
result_name=FB remarketing pixel
result_notes=this is a simple note
result_code_type=facebook
result_code_id=132434
result_code_html=
result_gdpr_id=7522395a6a22633061376e672161356b3153613638213d3d
result_gdpr_enabled=2

Example 4 (plain)

Request

https://joturl.com/a/i1/remarketings/edit?id=306663506735386e622f69266e366a586d6b722552513d3d&name=FB+remarketing+pixel¬es=this+is+a+simple+note&code_type=facebook&code_id=132434&code_html=&gdpr_id=7522395a6a22633061376e672161356b3153613638213d3d&gdpr_enabled=2&format=plain

Query parameters

          id = 306663506735386e622f69266e366a586d6b722552513d3d
        name = FB remarketing pixel
       notes = this is a simple note
   code_type = facebook
     code_id = 132434
   code_html = 
     gdpr_id = 7522395a6a22633061376e672161356b3153613638213d3d
gdpr_enabled = 2
      format = plain

Response

306663506735386e622f69266e366a586d6b722552513d3d
FB remarketing pixel
this is a simple note
facebook
132434

7522395a6a22633061376e672161356b3153613638213d3d
2
Required parameters
parameterdescription
idIDremarketing pixel (internal) ID
Optional parameters
parameterdescriptionmax length
code_htmlHTMLHTML code for custom remarketing script4000
code_idSTRINGpixel ID255
code_typeENUMpixel type, available codes: adroll, bing, custom, facebook, google_adwords, google_analytics, google_tag_manager, linkedin, manychat, pinterest, quora, reddit, snapchat, tiktok, twitter
gdpr_enabledINTEGER0 if GDPR is disabled, 1 if GDPR is enabled and the default model is used, 2 if GDPR is enabled and the model with ID gdpr_id is used
gdpr_idIDID of the GDPR template associated with this remarketing pixel
nameSTRINGremarketing pixel name100
notesSTRINGremarketing pixel notes128
Return values
parameterdescription
code_html[OPTIONAL] HTML code for custom remarketing script, returned only if code_html is passed
code_id[OPTIONAL] pixel ID, returned only if code_id is passed
code_type[OPTIONAL] pixel type, available codes: adroll, bing, custom, facebook, google_adwords, google_analytics, google_tag_manager, linkedin, manychat, pinterest, quora, reddit, snapchat, tiktok, twitter, returned only if code_type is passed
gdpr_enabled[OPTIONAL] 0 if GDPR is disabled, 1 if GDPR is enabled and the default model is used, 2 if GDPR is enabled and the model with ID gdpr_id is used, returned only if gdpr_enabled is passed
gdpr_id[OPTIONAL] ID of the GDPR template associated with this remarketing pixel, returned only if gdpr_id is passed
id[OPTIONAL] remarketing pixel (internal) ID, returned only if id is passed
name[OPTIONAL] remarketing pixel name, returned only if name is passed
notes[OPTIONAL] remarketing pixel notes, returned only if notes is passed

/remarketings/info

access: [READ]

This method returns information on a remarketing pixel, the returned information are that passed in the fields param (a comma separated list).

Example 1 (json)

Request

https://joturl.com/a/i1/remarketings/info?fields=clicks,code_id,code_type,creation,gdpr_enabled,gdpr_id,code_html,id,name,notes,performance,count

Query parameters

fields = clicks,code_id,code_type,creation,gdpr_enabled,gdpr_id,code_html,id,name,notes,performance,count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "clicks": 31234,
    "code_id": "132434",
    "code_type": "facebook",
    "creation": "2018-06-06 23:25:31.703",
    "gdpr_enabled": 1,
    "gdpr_id": "",
    "id": "306663506735386e622f69266e366a586d6b722552513d3d",
    "name": "FB remarketing pixel",
    "notes": "this is a simple note",
    "performance": ".000000000000"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/remarketings/info?fields=clicks,code_id,code_type,creation,gdpr_enabled,gdpr_id,code_html,id,name,notes,performance,count&format=xml

Query parameters

fields = clicks,code_id,code_type,creation,gdpr_enabled,gdpr_id,code_html,id,name,notes,performance,count
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <clicks>31234</clicks>  
    <code_id>132434</code_id>  
    <code_type>facebook</code_type>  
    <creation>2018-06-06 23:25:31.703</creation>  
    <gdpr_enabled>1</gdpr_enabled>  
    <gdpr_id></gdpr_id>  
    <id>306663506735386e622f69266e366a586d6b722552513d3d</id>  
    <name>FB remarketing pixel</name>  
    <notes>this is a simple note</notes>  
    <performance>.000000000000</performance>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/remarketings/info?fields=clicks,code_id,code_type,creation,gdpr_enabled,gdpr_id,code_html,id,name,notes,performance,count&format=txt

Query parameters

fields = clicks,code_id,code_type,creation,gdpr_enabled,gdpr_id,code_html,id,name,notes,performance,count
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_clicks=31234
result_code_id=132434
result_code_type=facebook
result_creation=2018-06-06 23:25:31.703
result_gdpr_enabled=1
result_gdpr_id=
result_id=306663506735386e622f69266e366a586d6b722552513d3d
result_name=FB remarketing pixel
result_notes=this is a simple note
result_performance=.000000000000

Example 4 (plain)

Request

https://joturl.com/a/i1/remarketings/info?fields=clicks,code_id,code_type,creation,gdpr_enabled,gdpr_id,code_html,id,name,notes,performance,count&format=plain

Query parameters

fields = clicks,code_id,code_type,creation,gdpr_enabled,gdpr_id,code_html,id,name,notes,performance,count
format = plain

Response

31234
132434
facebook
2018-06-06 23:25:31.703
1

306663506735386e622f69266e366a586d6b722552513d3d
FB remarketing pixel
this is a simple note
.000000000000
Required parameters
parameterdescription
fieldsARRAYcomma separated list of fields to return, available fields: clicks, code_id, code_type, creation, gdpr_enabled, gdpr_id, code_html, id, name, notes, performance, count
idIDID of the remarketing pixel
Return values
parameterdescription
clicksclick generated on the remarketing pixel
code_idpixel ID
code_typepixel type, available codes: adroll, bing, custom, facebook, google_adwords, google_analytics, google_tag_manager, linkedin, manychat, pinterest, quora, reddit, snapchat, tiktok, twitter
creationcreation date time (e.g., 2018-06-06 23:25:31.703)
gdpr_enabled0 if GDPR is disabled, 1 if GDPR is enabled and the default model is used, 2 if GDPR is enabled and the model with ID gdpr_id is used
gdpr_idID of the GDPR template associated with this remarketing pixel
idremarketing pixel (internal) ID
nameremarketing pixel name
notesremarketing pixel notes
performanceperformance meter of this remarking code, 0 if the remarketing pixel has 0 clicks or if is was created by less than 3 hours, otherwise it is the average number of clicks per hour

/remarketings/list

access: [READ]

This method returns a list of remarking code's data, specified in a comma separated input called fields.

Example 1 (json)

Request

https://joturl.com/a/i1/remarketings/list?fields=clicks,code_id,code_type,creation,gdpr_enabled,gdpr_id,code_html,id,name,notes,performance,count

Query parameters

fields = clicks,code_id,code_type,creation,gdpr_enabled,gdpr_id,code_html,id,name,notes,performance,count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": [
      {
        "clicks": 31234,
        "code_id": "132434",
        "user_retargeting_code_html": "",
        "code_type": "facebook",
        "creation": "2018-06-06 23:25:31.703",
        "gdpr_enabled": 1,
        "gdpr_id": "",
        "id": "306663506735386e622f69266e366a586d6b722552513d3d",
        "name": "FB remarketing pixel",
        "notes": "this is a simple note",
        "performance": ".000000000000"
      },
      {
        "clicks": 123,
        "code_id": "4568468",
        "user_retargeting_code_html": "",
        "code_type": "twitter",
        "creation": "2017-01-18 13:28:42.543",
        "gdpr_enabled": 1,
        "gdpr_id": "",
        "id": "806668506785886e642f69466e866a586d6b744552518d8d",
        "name": "TW remarketing pixel",
        "notes": "",
        "performance": ".000000000000"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/remarketings/list?fields=clicks,code_id,code_type,creation,gdpr_enabled,gdpr_id,code_html,id,name,notes,performance,count&format=xml

Query parameters

fields = clicks,code_id,code_type,creation,gdpr_enabled,gdpr_id,code_html,id,name,notes,performance,count
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <i0>
        <clicks>31234</clicks>  
        <code_id>132434</code_id>  
        <user_retargeting_code_html></user_retargeting_code_html>  
        <code_type>facebook</code_type>  
        <creation>2018-06-06 23:25:31.703</creation>  
        <gdpr_enabled>1</gdpr_enabled>  
        <gdpr_id></gdpr_id>  
        <id>306663506735386e622f69266e366a586d6b722552513d3d</id>  
        <name>FB remarketing pixel</name>  
        <notes>this is a simple note</notes>  
        <performance>.000000000000</performance>  
      </i0>  
      <i1>
        <clicks>123</clicks>  
        <code_id>4568468</code_id>  
        <user_retargeting_code_html></user_retargeting_code_html>  
        <code_type>twitter</code_type>  
        <creation>2017-01-18 13:28:42.543</creation>  
        <gdpr_enabled>1</gdpr_enabled>  
        <gdpr_id></gdpr_id>  
        <id>806668506785886e642f69466e866a586d6b744552518d8d</id>  
        <name>TW remarketing pixel</name>  
        <notes></notes>  
        <performance>.000000000000</performance>  
      </i1>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/remarketings/list?fields=clicks,code_id,code_type,creation,gdpr_enabled,gdpr_id,code_html,id,name,notes,performance,count&format=txt

Query parameters

fields = clicks,code_id,code_type,creation,gdpr_enabled,gdpr_id,code_html,id,name,notes,performance,count
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_0_clicks=31234
result_data_0_code_id=132434
result_data_0_user_retargeting_code_html=
result_data_0_code_type=facebook
result_data_0_creation=2018-06-06 23:25:31.703
result_data_0_gdpr_enabled=1
result_data_0_gdpr_id=
result_data_0_id=306663506735386e622f69266e366a586d6b722552513d3d
result_data_0_name=FB remarketing pixel
result_data_0_notes=this is a simple note
result_data_0_performance=.000000000000
result_data_1_clicks=123
result_data_1_code_id=4568468
result_data_1_user_retargeting_code_html=
result_data_1_code_type=twitter
result_data_1_creation=2017-01-18 13:28:42.543
result_data_1_gdpr_enabled=1
result_data_1_gdpr_id=
result_data_1_id=806668506785886e642f69466e866a586d6b744552518d8d
result_data_1_name=TW remarketing pixel
result_data_1_notes=
result_data_1_performance=.000000000000

Example 4 (plain)

Request

https://joturl.com/a/i1/remarketings/list?fields=clicks,code_id,code_type,creation,gdpr_enabled,gdpr_id,code_html,id,name,notes,performance,count&format=plain

Query parameters

fields = clicks,code_id,code_type,creation,gdpr_enabled,gdpr_id,code_html,id,name,notes,performance,count
format = plain

Response

31234
132434

facebook
2018-06-06 23:25:31.703
1

306663506735386e622f69266e366a586d6b722552513d3d
FB remarketing pixel
this is a simple note
.000000000000
123
4568468

twitter
2017-01-18 13:28:42.543
1

806668506785886e642f69466e866a586d6b744552518d8d
TW remarketing pixel

.000000000000
Required parameters
parameterdescription
fieldsARRAYcomma separated list of fields to return, available fields: clicks, code_id, code_type, creation, gdpr_enabled, gdpr_id, code_html, id, name, notes, performance, count
Optional parameters
parameterdescription
lengthINTEGERextracts this number of remarketing pixels (maxmimum allowed: 100)
orderbyARRAYorders remarketing pixels by field, available fields: clicks, code_id, code_type, creation, gdpr_enabled, gdpr_id, code_html, id, name, notes, performance, count
searchSTRINGfilters remarketing pixels to be extracted by searching them
sortSTRINGsorts remarketing pixels in ascending (ASC) or descending (DESC) order
startINTEGERstarts to extract remarketing pixels from this position
typesARRAYfilters list by code type(s), it can be empty, all or a comma separated list of these codes: facebook, twitter, linkedin, pinterest, bing, google_analytics, google_adwords, google_tag_manager, manychat, quora, adroll, snapchat, tiktok, reddit, custom
Return values
parameterdescription
dataarray containing required information on remarketing pixels

/remarketings/property

access: [READ]

This method returns a list of supported remarketing pixels.

Example 1 (json)

Request

https://joturl.com/a/i1/remarketings/property

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "adroll": {
      "enabled": 1,
      "label": "Adroll Pixel",
      "title": "Advertiser ID|Pixel ID",
      "helper": "",
      "abbr": "AR"
    },
    "bing": {
      "enabled": 1,
      "label": "Bing Universal Event Tracking",
      "title": "UET Pixel ID",
      "helper": "",
      "abbr": "BNG"
    },
    "custom": {
      "enabled": 1,
      "label": "Custom remarketing code",
      "title": "Remarketing code (including opening and closing tags)",
      "helper": "",
      "abbr": "CSTM"
    },
    "facebook": {
      "enabled": 1,
      "label": "Facebook Pixel",
      "title": "Pixel ID",
      "helper": "",
      "abbr": "FB"
    },
    "google_adwords": {
      "enabled": 1,
      "label": "AdWords tag for websites",
      "title": "Conversion ID",
      "helper": "",
      "abbr": "ADWS"
    },
    "google_analytics": {
      "enabled": 1,
      "label": "Google Analytics Tracking code",
      "title": "Tracking ID",
      "helper": "",
      "abbr": "GA"
    },
    "google_tag_manager": {
      "enabled": 1,
      "label": "Google Tag Manager",
      "title": "GTM ID",
      "helper": "",
      "abbr": "GTAG"
    },
    "linkedin": {
      "enabled": 1,
      "label": "LinkedIn Insight Tag",
      "title": "Partner ID (linkedin_data_partner_id)",
      "helper": "",
      "abbr": "LI"
    },
    "manychat": {
      "enabled": 1,
      "label": "ManyChat Pixel\/Widget",
      "title": "Pixel\/Widget ID",
      "helper": "",
      "abbr": "MC"
    },
    "pinterest": {
      "enabled": 1,
      "label": "Pinterest Conversion Tag",
      "title": "Pinterest Pixel ID",
      "helper": "",
      "abbr": "PIN"
    },
    "quora": {
      "enabled": 1,
      "label": "Quora Pixel ID",
      "title": "Pixel ID",
      "helper": "",
      "abbr": "Q"
    },
    "reddit": {
      "enabled": 1,
      "label": "Reddit Pixel",
      "title": "ID Inserzionista",
      "helper": "",
      "abbr": "R"
    },
    "snapchat": {
      "enabled": 1,
      "label": "Snapchat Pixel",
      "title": "Pixel ID",
      "helper": "",
      "abbr": "SC"
    },
    "tiktok": {
      "enabled": 1,
      "label": "TikTok Pixel",
      "title": "Pixel ID",
      "helper": "",
      "abbr": "TT"
    },
    "twitter": {
      "enabled": 1,
      "label": "Twitter conversion tracking",
      "title": "Website Tag ID",
      "helper": "",
      "abbr": "TW"
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/remarketings/property?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <adroll>
      <enabled>1</enabled>  
      <label>Adroll Pixel</label>  
      <title>Advertiser ID|Pixel ID</title>  
      <helper></helper>  
      <abbr>AR</abbr>  
    </adroll>  
    <bing>
      <enabled>1</enabled>  
      <label>Bing Universal Event Tracking</label>  
      <title>UET Pixel ID</title>  
      <helper></helper>  
      <abbr>BNG</abbr>  
    </bing>  
    <custom>
      <enabled>1</enabled>  
      <label>Custom remarketing code</label>  
      <title>Remarketing code (including opening and closing tags)</title>  
      <helper></helper>  
      <abbr>CSTM</abbr>  
    </custom>  
    <facebook>
      <enabled>1</enabled>  
      <label>Facebook Pixel</label>  
      <title>Pixel ID</title>  
      <helper></helper>  
      <abbr>FB</abbr>  
    </facebook>  
    <google_adwords>
      <enabled>1</enabled>  
      <label>AdWords tag for websites</label>  
      <title>Conversion ID</title>  
      <helper></helper>  
      <abbr>ADWS</abbr>  
    </google_adwords>  
    <google_analytics>
      <enabled>1</enabled>  
      <label>Google Analytics Tracking code</label>  
      <title>Tracking ID</title>  
      <helper></helper>  
      <abbr>GA</abbr>  
    </google_analytics>  
    <google_tag_manager>
      <enabled>1</enabled>  
      <label>Google Tag Manager</label>  
      <title>GTM ID</title>  
      <helper></helper>  
      <abbr>GTAG</abbr>  
    </google_tag_manager>  
    <linkedin>
      <enabled>1</enabled>  
      <label>LinkedIn Insight Tag</label>  
      <title>Partner ID (linkedin_data_partner_id)</title>  
      <helper></helper>  
      <abbr>LI</abbr>  
    </linkedin>  
    <manychat>
      <enabled>1</enabled>  
      <label>ManyChat Pixel/Widget</label>  
      <title>Pixel/Widget ID</title>  
      <helper></helper>  
      <abbr>MC</abbr>  
    </manychat>  
    <pinterest>
      <enabled>1</enabled>  
      <label>Pinterest Conversion Tag</label>  
      <title>Pinterest Pixel ID</title>  
      <helper></helper>  
      <abbr>PIN</abbr>  
    </pinterest>  
    <quora>
      <enabled>1</enabled>  
      <label>Quora Pixel ID</label>  
      <title>Pixel ID</title>  
      <helper></helper>  
      <abbr>Q</abbr>  
    </quora>  
    <reddit>
      <enabled>1</enabled>  
      <label>Reddit Pixel</label>  
      <title>ID Inserzionista</title>  
      <helper></helper>  
      <abbr>R</abbr>  
    </reddit>  
    <snapchat>
      <enabled>1</enabled>  
      <label>Snapchat Pixel</label>  
      <title>Pixel ID</title>  
      <helper></helper>  
      <abbr>SC</abbr>  
    </snapchat>  
    <tiktok>
      <enabled>1</enabled>  
      <label>TikTok Pixel</label>  
      <title>Pixel ID</title>  
      <helper></helper>  
      <abbr>TT</abbr>  
    </tiktok>  
    <twitter>
      <enabled>1</enabled>  
      <label>Twitter conversion tracking</label>  
      <title>Website Tag ID</title>  
      <helper></helper>  
      <abbr>TW</abbr>  
    </twitter>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/remarketings/property?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_adroll_enabled=1
result_adroll_label=Adroll Pixel
result_adroll_title=Advertiser ID|Pixel ID
result_adroll_helper=
result_adroll_abbr=AR
result_bing_enabled=1
result_bing_label=Bing Universal Event Tracking
result_bing_title=UET Pixel ID
result_bing_helper=
result_bing_abbr=BNG
result_custom_enabled=1
result_custom_label=Custom remarketing code
result_custom_title=Remarketing code (including opening and closing tags)
result_custom_helper=
result_custom_abbr=CSTM
result_facebook_enabled=1
result_facebook_label=Facebook Pixel
result_facebook_title=Pixel ID
result_facebook_helper=
result_facebook_abbr=FB
result_google_adwords_enabled=1
result_google_adwords_label=AdWords tag for websites
result_google_adwords_title=Conversion ID
result_google_adwords_helper=
result_google_adwords_abbr=ADWS
result_google_analytics_enabled=1
result_google_analytics_label=Google Analytics Tracking code
result_google_analytics_title=Tracking ID
result_google_analytics_helper=
result_google_analytics_abbr=GA
result_google_tag_manager_enabled=1
result_google_tag_manager_label=Google Tag Manager
result_google_tag_manager_title=GTM ID
result_google_tag_manager_helper=
result_google_tag_manager_abbr=GTAG
result_linkedin_enabled=1
result_linkedin_label=LinkedIn Insight Tag
result_linkedin_title=Partner ID (linkedin_data_partner_id)
result_linkedin_helper=
result_linkedin_abbr=LI
result_manychat_enabled=1
result_manychat_label=ManyChat Pixel/Widget
result_manychat_title=Pixel/Widget ID
result_manychat_helper=
result_manychat_abbr=MC
result_pinterest_enabled=1
result_pinterest_label=Pinterest Conversion Tag
result_pinterest_title=Pinterest Pixel ID
result_pinterest_helper=
result_pinterest_abbr=PIN
result_quora_enabled=1
result_quora_label=Quora Pixel ID
result_quora_title=Pixel ID
result_quora_helper=
result_quora_abbr=Q
result_reddit_enabled=1
result_reddit_label=Reddit Pixel
result_reddit_title=ID Inserzionista
result_reddit_helper=
result_reddit_abbr=R
result_snapchat_enabled=1
result_snapchat_label=Snapchat Pixel
result_snapchat_title=Pixel ID
result_snapchat_helper=
result_snapchat_abbr=SC
result_tiktok_enabled=1
result_tiktok_label=TikTok Pixel
result_tiktok_title=Pixel ID
result_tiktok_helper=
result_tiktok_abbr=TT
result_twitter_enabled=1
result_twitter_label=Twitter conversion tracking
result_twitter_title=Website Tag ID
result_twitter_helper=
result_twitter_abbr=TW

Example 4 (plain)

Request

https://joturl.com/a/i1/remarketings/property?format=plain

Query parameters

format = plain

Response

1
Adroll Pixel
Advertiser ID|Pixel ID

AR
1
Bing Universal Event Tracking
UET Pixel ID

BNG
1
Custom remarketing code
Remarketing code (including opening and closing tags)

CSTM
1
Facebook Pixel
Pixel ID

FB
1
AdWords tag for websites
Conversion ID

ADWS
1
Google Analytics Tracking code
Tracking ID

GA
1
Google Tag Manager
GTM ID

GTAG
1
LinkedIn Insight Tag
Partner ID (linkedin_data_partner_id)

LI
1
ManyChat Pixel/Widget
Pixel/Widget ID

MC
1
Pinterest Conversion Tag
Pinterest Pixel ID

PIN
1
Quora Pixel ID
Pixel ID

Q
1
Reddit Pixel
ID Inserzionista

R
1
Snapchat Pixel
Pixel ID

SC
1
TikTok Pixel
Pixel ID

TT
1
Twitter conversion tracking
Website Tag ID

TW
Return values
parameterdescription
dataarray containing supported remarketing pixels

/remarketings/urls

/remarketings/urls/count

access: [READ]

This method returns the number of user's tracking links linked to a remarketing pixel.

Example 1 (json)

Request

https://joturl.com/a/i1/remarketings/urls/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 8
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/remarketings/urls/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>8</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/remarketings/urls/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=8

Example 4 (plain)

Request

https://joturl.com/a/i1/remarketings/urls/count?format=plain

Query parameters

format = plain

Response

8

Example 5 (json)

Request

https://joturl.com/a/i1/remarketings/urls/count?search=test

Query parameters

search = test

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 3
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/remarketings/urls/count?search=test&format=xml

Query parameters

search = test
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>3</count>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/remarketings/urls/count?search=test&format=txt

Query parameters

search = test
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=3

Example 8 (plain)

Request

https://joturl.com/a/i1/remarketings/urls/count?search=test&format=plain

Query parameters

search = test
format = plain

Response

3
Required parameters
parameterdescription
remarketing_idIDremarketing pixel (internal) ID
Optional parameters
parameterdescription
searchSTRINGcount tracking links by searching them
Return values
parameterdescription
countnumber of tracking links (filtered by search if passed)

/remarketings/urls/list

access: [READ]

This method returns a list of user's tracking links data linked to a remarketing pixel.

Example 1 (json)

Request

https://joturl.com/a/i1/remarketings/urls/list?fields=count,id,project_name,long_url,project_id,short_url,visits

Query parameters

fields = count,id,project_name,long_url,project_id,short_url,visits

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": [
      {
        "id": "9b00e51744ed27d0d82c4ab5733a5f9d",
        "project_name": "project name 1",
        "long_url": "https:\/\/google.com\/",
        "project_id": "2eb7a11823d8e0212183acd20b74fc30",
        "short_url": "https:\/\/my.domain.ext\/alias1",
        "visits": 1234
      },
      {
        "id": "695f274289b5806dacc885f61902770f",
        "project_name": "project name 2",
        "long_url": "https:\/\/google.com\/",
        "project_id": "b99afd1b8729c26ec727cbd4d0e77625",
        "short_url": "https:\/\/my.domain.ext\/alias2",
        "visits": 4321
      }
    ],
    "count": 2
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/remarketings/urls/list?fields=count,id,project_name,long_url,project_id,short_url,visits&format=xml

Query parameters

fields = count,id,project_name,long_url,project_id,short_url,visits
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <i0>
        <id>9b00e51744ed27d0d82c4ab5733a5f9d</id>  
        <project_name>project name 1</project_name>  
        <long_url>https://google.com/</long_url>  
        <project_id>2eb7a11823d8e0212183acd20b74fc30</project_id>  
        <short_url>https://my.domain.ext/alias1</short_url>  
        <visits>1234</visits>  
      </i0>  
      <i1>
        <id>695f274289b5806dacc885f61902770f</id>  
        <project_name>project name 2</project_name>  
        <long_url>https://google.com/</long_url>  
        <project_id>b99afd1b8729c26ec727cbd4d0e77625</project_id>  
        <short_url>https://my.domain.ext/alias2</short_url>  
        <visits>4321</visits>  
      </i1>  
    </data>  
    <count>2</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/remarketings/urls/list?fields=count,id,project_name,long_url,project_id,short_url,visits&format=txt

Query parameters

fields = count,id,project_name,long_url,project_id,short_url,visits
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_0_id=9b00e51744ed27d0d82c4ab5733a5f9d
result_data_0_project_name=project name 1
result_data_0_long_url=https://google.com/
result_data_0_project_id=2eb7a11823d8e0212183acd20b74fc30
result_data_0_short_url=https://my.domain.ext/alias1
result_data_0_visits=1234
result_data_1_id=695f274289b5806dacc885f61902770f
result_data_1_project_name=project name 2
result_data_1_long_url=https://google.com/
result_data_1_project_id=b99afd1b8729c26ec727cbd4d0e77625
result_data_1_short_url=https://my.domain.ext/alias2
result_data_1_visits=4321
result_count=2

Example 4 (plain)

Request

https://joturl.com/a/i1/remarketings/urls/list?fields=count,id,project_name,long_url,project_id,short_url,visits&format=plain

Query parameters

fields = count,id,project_name,long_url,project_id,short_url,visits
format = plain

Response

https://my.domain.ext/alias1
https://my.domain.ext/alias2
2
Required parameters
parameterdescription
fieldsARRAYcomma separated list of fields to return, available fields: project_name, long_url, id, project_id, short_url, visits, count
remarketing_idIDremarketing pixel (internal) ID
Optional parameters
parameterdescription
lengthINTEGERextracts this number of items (maxmimum allowed: 100)
orderbyARRAYorders items by field, available fields: project_name, long_url, id, project_id, short_url, visits, count
searchSTRINGfilters items to be extracted by searching them
sortSTRINGsorts items in ascending (ASC) or descending (DESC) order
startINTEGERstarts to extract items from this position
Return values
parameterdescription
count[OPTIONAL] total number of (filtered) urls, returned only if count is passed in fields
dataarray containing information on the tracking link associated with the remarketing pixel

/stats

/stats/conversions

/stats/conversions/get

access: [READ]

This method returns information about stats.

Example 1 (json)

Request

https://joturl.com/a/i1/stats/conversions/get?conversion_id=5bd89d993c7cd5f375e334282d289fc3&charts=tl_snapshot&start_date=2020-01-01&end_date=2020-10-13

Query parameters

conversion_id = 5bd89d993c7cd5f375e334282d289fc3
       charts = tl_snapshot
   start_date = 2020-01-01
     end_date = 2020-10-13

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "tl_snapshot": {
      "type": "line",
      "series": [
        "visits",
        "unique_visits",
        "mobile",
        "unique_mobile",
        "qrcode_scans"
      ],
      "types": {
        "x": "Ym",
        "count": "int"
      },
      "data": {
        "visits": {
          "2020-03": {
            "count": 2
          }
        },
        "unique_visits": {
          "2020-03": {
            "count": 0
          }
        },
        "mobile": {
          "2020-03": {
            "count": 0
          }
        },
        "unique_mobile": {
          "2020-03": {
            "count": 0
          }
        },
        "qrcode_scans": {
          "2020-03": {
            "count": 0
          }
        }
      }
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/stats/conversions/get?conversion_id=5bd89d993c7cd5f375e334282d289fc3&charts=tl_snapshot&start_date=2020-01-01&end_date=2020-10-13&format=xml

Query parameters

conversion_id = 5bd89d993c7cd5f375e334282d289fc3
       charts = tl_snapshot
   start_date = 2020-01-01
     end_date = 2020-10-13
       format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <tl_snapshot>
      <type>line</type>  
      <series>
        <i0>visits</i0>  
        <i1>unique_visits</i1>  
        <i2>mobile</i2>  
        <i3>unique_mobile</i3>  
        <i4>qrcode_scans</i4>  
      </series>  
      <types>
        <x>Ym</x>  
        <count>int</count>  
      </types>  
      <data>
        <visits>
          <2020-03>
            <count>2</count>  
          </2020-03>  
        </visits>  
        <unique_visits>
          <2020-03>
            <count>0</count>  
          </2020-03>  
        </unique_visits>  
        <mobile>
          <2020-03>
            <count>0</count>  
          </2020-03>  
        </mobile>  
        <unique_mobile>
          <2020-03>
            <count>0</count>  
          </2020-03>  
        </unique_mobile>  
        <qrcode_scans>
          <2020-03>
            <count>0</count>  
          </2020-03>  
        </qrcode_scans>  
      </data>  
    </tl_snapshot>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/stats/conversions/get?conversion_id=5bd89d993c7cd5f375e334282d289fc3&charts=tl_snapshot&start_date=2020-01-01&end_date=2020-10-13&format=txt

Query parameters

conversion_id = 5bd89d993c7cd5f375e334282d289fc3
       charts = tl_snapshot
   start_date = 2020-01-01
     end_date = 2020-10-13
       format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_tl_snapshot_type=line
result_tl_snapshot_series_0=visits
result_tl_snapshot_series_1=unique_visits
result_tl_snapshot_series_2=mobile
result_tl_snapshot_series_3=unique_mobile
result_tl_snapshot_series_4=qrcode_scans
result_tl_snapshot_types_x=Ym
result_tl_snapshot_types_count=int
result_tl_snapshot_data_visits_2020-03_count=2
result_tl_snapshot_data_unique_visits_2020-03_count=0
result_tl_snapshot_data_mobile_2020-03_count=0
result_tl_snapshot_data_unique_mobile_2020-03_count=0
result_tl_snapshot_data_qrcode_scans_2020-03_count=0

Example 4 (plain)

Request

https://joturl.com/a/i1/stats/conversions/get?conversion_id=5bd89d993c7cd5f375e334282d289fc3&charts=tl_snapshot&start_date=2020-01-01&end_date=2020-10-13&format=plain

Query parameters

conversion_id = 5bd89d993c7cd5f375e334282d289fc3
       charts = tl_snapshot
   start_date = 2020-01-01
     end_date = 2020-10-13
       format = plain

Response

line
visits
unique_visits
mobile
unique_mobile
qrcode_scans
Ym
int
2
0
0
0
0

Example 5 (json)

Request

https://joturl.com/a/i1/stats/conversions/get?conversion_id=3a0a744a34f68b423aa49cc5c3fe7971&url_id=7242a2dcea3115e61e1a16b9db9ef5fc&charts=tl_countries&start_date=2020-10-01&end_date=2020-10-13

Query parameters

conversion_id = 3a0a744a34f68b423aa49cc5c3fe7971
       url_id = 7242a2dcea3115e61e1a16b9db9ef5fc
       charts = tl_countries
   start_date = 2020-10-01
     end_date = 2020-10-13

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "type": "doughnut",
    "series": [
      "countries"
    ],
    "types": {
      "count": "int"
    },
    "data": {
      "countries": {
        "Italia": {
          "count": 2
        }
      }
    },
    "table": {
      "Italia": {
        "visits": 2,
        "unique_visits": 0,
        "mobile": 0,
        "unique_mobile": 0,
        "qrcode_scans": 0
      }
    }
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/stats/conversions/get?conversion_id=3a0a744a34f68b423aa49cc5c3fe7971&url_id=7242a2dcea3115e61e1a16b9db9ef5fc&charts=tl_countries&start_date=2020-10-01&end_date=2020-10-13&format=xml

Query parameters

conversion_id = 3a0a744a34f68b423aa49cc5c3fe7971
       url_id = 7242a2dcea3115e61e1a16b9db9ef5fc
       charts = tl_countries
   start_date = 2020-10-01
     end_date = 2020-10-13
       format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <type>doughnut</type>  
    <series>
      <i0>countries</i0>  
    </series>  
    <types>
      <count>int</count>  
    </types>  
    <data>
      <countries>
        <Italia>
          <count>2</count>  
        </Italia>  
      </countries>  
    </data>  
    <table>
      <Italia>
        <visits>2</visits>  
        <unique_visits>0</unique_visits>  
        <mobile>0</mobile>  
        <unique_mobile>0</unique_mobile>  
        <qrcode_scans>0</qrcode_scans>  
      </Italia>  
    </table>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/stats/conversions/get?conversion_id=3a0a744a34f68b423aa49cc5c3fe7971&url_id=7242a2dcea3115e61e1a16b9db9ef5fc&charts=tl_countries&start_date=2020-10-01&end_date=2020-10-13&format=txt

Query parameters

conversion_id = 3a0a744a34f68b423aa49cc5c3fe7971
       url_id = 7242a2dcea3115e61e1a16b9db9ef5fc
       charts = tl_countries
   start_date = 2020-10-01
     end_date = 2020-10-13
       format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_type=doughnut
result_series_0=countries
result_types_count=int
result_data_countries_Italia_count=2
result_table_Italia_visits=2
result_table_Italia_unique_visits=0
result_table_Italia_mobile=0
result_table_Italia_unique_mobile=0
result_table_Italia_qrcode_scans=0

Example 8 (plain)

Request

https://joturl.com/a/i1/stats/conversions/get?conversion_id=3a0a744a34f68b423aa49cc5c3fe7971&url_id=7242a2dcea3115e61e1a16b9db9ef5fc&charts=tl_countries&start_date=2020-10-01&end_date=2020-10-13&format=plain

Query parameters

conversion_id = 3a0a744a34f68b423aa49cc5c3fe7971
       url_id = 7242a2dcea3115e61e1a16b9db9ef5fc
       charts = tl_countries
   start_date = 2020-10-01
     end_date = 2020-10-13
       format = plain

Response

doughnut
countries
int
2
2
0
0
0
0
Required parameters
parameterdescription
chartsARRAYcomma separated list of charts, for a detailed list of charts see i1/stats/conversions/info
Optional parameters
parameterdescription
conversion_idIDID of the conversion for which to extract statistics
end_dateDATEextract statistics up to this date (included)
ep00_idIDfilter conversion data by using the ID of the extended parameter ep00, see i1/conversions/codes/params/list for details
ep01_idIDfilter conversion data by using the ID of the extended parameter ep01, see i1/conversions/codes/params/list for details
ep02_idIDfilter conversion data by using the ID of the extended parameter ep02, see i1/conversions/codes/params/list for details
ep03_idIDfilter conversion data by using the ID of the extended parameter ep03, see i1/conversions/codes/params/list for details
ep04_idIDfilter conversion data by using the ID of the extended parameter ep04, see i1/conversions/codes/params/list for details
ep05_idIDfilter conversion data by using the ID of the extended parameter ep05, see i1/conversions/codes/params/list for details
ep06_idIDfilter conversion data by using the ID of the extended parameter ep06, see i1/conversions/codes/params/list for details
ep07_idIDfilter conversion data by using the ID of the extended parameter ep07, see i1/conversions/codes/params/list for details
ep08_idIDfilter conversion data by using the ID of the extended parameter ep08, see i1/conversions/codes/params/list for details
ep09_idIDfilter conversion data by using the ID of the extended parameter ep09, see i1/conversions/codes/params/list for details
ep10_idIDfilter conversion data by using the ID of the extended parameter ep10, see i1/conversions/codes/params/list for details
ep11_idIDfilter conversion data by using the ID of the extended parameter ep11, see i1/conversions/codes/params/list for details
ep12_idIDfilter conversion data by using the ID of the extended parameter ep12, see i1/conversions/codes/params/list for details
ep13_idIDfilter conversion data by using the ID of the extended parameter ep13, see i1/conversions/codes/params/list for details
ep14_idIDfilter conversion data by using the ID of the extended parameter ep14, see i1/conversions/codes/params/list for details
map_typeSTRINGused only when charts contains tl_map, see i1/stats/projects/get for details
param_idIDfilter conversion data by using the ID of the parameter, see i1/conversions/codes/params/list for details
start_dateDATEextract statistics from this date (included)
url_idIDID of the tracking link for which to extract statistics
Return values
parameterdescription
dataJSON object in the format {"chart": {[CHART INFO]}}

/stats/conversions/info

access: [READ]

This method returns information about stats.

Example 1 (json)

Request

https://joturl.com/a/i1/stats/conversions/info?conversion_id=62add2823a08895e58282a21f2123735&url_id=b5f71db62ed30b3cbbe2267f350e8c90

Query parameters

conversion_id = 62add2823a08895e58282a21f2123735
       url_id = b5f71db62ed30b3cbbe2267f350e8c90

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": [
    "tl_snapshot",
    "tl_map",
    "tl_countries",
    "tl_regions",
    "tl_cities",
    "tl_languages",
    "tl_referrers",
    "tl_devices",
    "tl_browsers",
    "tl_platforms",
    "tl_operating_systems",
    "tl_ips",
    "tl_bots",
    "tl_conversions",
    "tl_commissions"
  ]
}

Example 2 (xml)

Request

https://joturl.com/a/i1/stats/conversions/info?conversion_id=62add2823a08895e58282a21f2123735&url_id=b5f71db62ed30b3cbbe2267f350e8c90&format=xml

Query parameters

conversion_id = 62add2823a08895e58282a21f2123735
       url_id = b5f71db62ed30b3cbbe2267f350e8c90
       format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <i0>tl_snapshot</i0>  
    <i1>tl_map</i1>  
    <i2>tl_countries</i2>  
    <i3>tl_regions</i3>  
    <i4>tl_cities</i4>  
    <i5>tl_languages</i5>  
    <i6>tl_referrers</i6>  
    <i7>tl_devices</i7>  
    <i8>tl_browsers</i8>  
    <i9>tl_platforms</i9>  
    <i10>tl_operating_systems</i10>  
    <i11>tl_ips</i11>  
    <i12>tl_bots</i12>  
    <i13>tl_conversions</i13>  
    <i14>tl_commissions</i14>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/stats/conversions/info?conversion_id=62add2823a08895e58282a21f2123735&url_id=b5f71db62ed30b3cbbe2267f350e8c90&format=txt

Query parameters

conversion_id = 62add2823a08895e58282a21f2123735
       url_id = b5f71db62ed30b3cbbe2267f350e8c90
       format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_0=tl_snapshot
result_1=tl_map
result_2=tl_countries
result_3=tl_regions
result_4=tl_cities
result_5=tl_languages
result_6=tl_referrers
result_7=tl_devices
result_8=tl_browsers
result_9=tl_platforms
result_10=tl_operating_systems
result_11=tl_ips
result_12=tl_bots
result_13=tl_conversions
result_14=tl_commissions

Example 4 (plain)

Request

https://joturl.com/a/i1/stats/conversions/info?conversion_id=62add2823a08895e58282a21f2123735&url_id=b5f71db62ed30b3cbbe2267f350e8c90&format=plain

Query parameters

conversion_id = 62add2823a08895e58282a21f2123735
       url_id = b5f71db62ed30b3cbbe2267f350e8c90
       format = plain

Response

tl_snapshot
tl_map
tl_countries
tl_regions
tl_cities
tl_languages
tl_referrers
tl_devices
tl_browsers
tl_platforms
tl_operating_systems
tl_ips
tl_bots
tl_conversions
tl_commissions

Example 5 (json)

Request

https://joturl.com/a/i1/stats/conversions/info?conversion_id=8e3a0381c5180221f754e3657b8118ad

Query parameters

conversion_id = 8e3a0381c5180221f754e3657b8118ad

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": [
    "tl_snapshot",
    "tl_map",
    "tl_countries",
    "tl_regions",
    "tl_cities",
    "tl_languages",
    "tl_referrers",
    "tl_devices",
    "tl_browsers",
    "tl_platforms",
    "tl_operating_systems",
    "tl_ips",
    "tl_bots",
    "summary_snapshot_value",
    "summary_snapshot_commission"
  ]
}

Example 6 (xml)

Request

https://joturl.com/a/i1/stats/conversions/info?conversion_id=8e3a0381c5180221f754e3657b8118ad&format=xml

Query parameters

conversion_id = 8e3a0381c5180221f754e3657b8118ad
       format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <i0>tl_snapshot</i0>  
    <i1>tl_map</i1>  
    <i2>tl_countries</i2>  
    <i3>tl_regions</i3>  
    <i4>tl_cities</i4>  
    <i5>tl_languages</i5>  
    <i6>tl_referrers</i6>  
    <i7>tl_devices</i7>  
    <i8>tl_browsers</i8>  
    <i9>tl_platforms</i9>  
    <i10>tl_operating_systems</i10>  
    <i11>tl_ips</i11>  
    <i12>tl_bots</i12>  
    <i13>summary_snapshot_value</i13>  
    <i14>summary_snapshot_commission</i14>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/stats/conversions/info?conversion_id=8e3a0381c5180221f754e3657b8118ad&format=txt

Query parameters

conversion_id = 8e3a0381c5180221f754e3657b8118ad
       format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_0=tl_snapshot
result_1=tl_map
result_2=tl_countries
result_3=tl_regions
result_4=tl_cities
result_5=tl_languages
result_6=tl_referrers
result_7=tl_devices
result_8=tl_browsers
result_9=tl_platforms
result_10=tl_operating_systems
result_11=tl_ips
result_12=tl_bots
result_13=summary_snapshot_value
result_14=summary_snapshot_commission

Example 8 (plain)

Request

https://joturl.com/a/i1/stats/conversions/info?conversion_id=8e3a0381c5180221f754e3657b8118ad&format=plain

Query parameters

conversion_id = 8e3a0381c5180221f754e3657b8118ad
       format = plain

Response

tl_snapshot
tl_map
tl_countries
tl_regions
tl_cities
tl_languages
tl_referrers
tl_devices
tl_browsers
tl_platforms
tl_operating_systems
tl_ips
tl_bots
summary_snapshot_value
summary_snapshot_commission

Example 9 (json)

Request

https://joturl.com/a/i1/stats/conversions/info

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": [
    "summary_snapshot_value",
    "summary_snapshot_commission"
  ]
}

Example 10 (xml)

Request

https://joturl.com/a/i1/stats/conversions/info?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <i0>summary_snapshot_value</i0>  
    <i1>summary_snapshot_commission</i1>  
  </result>  
</response>

Example 11 (txt)

Request

https://joturl.com/a/i1/stats/conversions/info?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_0=summary_snapshot_value
result_1=summary_snapshot_commission

Example 12 (plain)

Request

https://joturl.com/a/i1/stats/conversions/info?format=plain

Query parameters

format = plain

Response

summary_snapshot_value
summary_snapshot_commission
Optional parameters
parameterdescription
conversion_idIDID of the conversion for which to extract statistics
url_idIDID of the tracking link for which to extract statistics
Return values
parameterdescription
dataarray of available charts for the given conversion_id and url_id

/stats/ctas

/stats/ctas/get

access: [READ]

This method returns information about stats.

Example 1 (json)

Request

https://joturl.com/a/i1/stats/ctas/get?charts=summary_snapshot&start_date=2018-09-01&end_date=2020-10-13

Query parameters

    charts = summary_snapshot
start_date = 2018-09-01
  end_date = 2020-10-13

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "summary_snapshot": {
      "type": "line",
      "series": [
        "ctas_visits",
        "ctas_clicks"
      ],
      "types": {
        "x": "Ym",
        "visits": "int",
        "clicks": "int"
      },
      "data": {
        "ctas_visits": {
          "2018-09": {
            "visits": 27
          },
          "2019-03": {
            "visits": 27
          },
          "2020-02": {
            "visits": 8
          },
          "2020-03": {
            "visits": 6
          },
          "2020-05": {
            "visits": 17
          },
          "2020-10": {
            "visits": 17
          }
        },
        "ctas_clicks": {
          "2018-09": {
            "clicks": 2
          },
          "2019-03": {
            "clicks": 2
          },
          "2020-02": {
            "clicks": 1
          },
          "2020-03": {
            "clicks": 1
          },
          "2020-05": {
            "clicks": 9
          },
          "2020-10": {
            "clicks": 2
          }
        }
      }
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/stats/ctas/get?charts=summary_snapshot&start_date=2018-09-01&end_date=2020-10-13&format=xml

Query parameters

    charts = summary_snapshot
start_date = 2018-09-01
  end_date = 2020-10-13
    format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <summary_snapshot>
      <type>line</type>  
      <series>
        <i0>ctas_visits</i0>  
        <i1>ctas_clicks</i1>  
      </series>  
      <types>
        <x>Ym</x>  
        <visits>int</visits>  
        <clicks>int</clicks>  
      </types>  
      <data>
        <ctas_visits>
          <2018-09>
            <visits>27</visits>  
          </2018-09>  
          <2019-03>
            <visits>27</visits>  
          </2019-03>  
          <2020-02>
            <visits>8</visits>  
          </2020-02>  
          <2020-03>
            <visits>6</visits>  
          </2020-03>  
          <2020-05>
            <visits>17</visits>  
          </2020-05>  
          <2020-10>
            <visits>17</visits>  
          </2020-10>  
        </ctas_visits>  
        <ctas_clicks>
          <2018-09>
            <clicks>2</clicks>  
          </2018-09>  
          <2019-03>
            <clicks>2</clicks>  
          </2019-03>  
          <2020-02>
            <clicks>1</clicks>  
          </2020-02>  
          <2020-03>
            <clicks>1</clicks>  
          </2020-03>  
          <2020-05>
            <clicks>9</clicks>  
          </2020-05>  
          <2020-10>
            <clicks>2</clicks>  
          </2020-10>  
        </ctas_clicks>  
      </data>  
    </summary_snapshot>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/stats/ctas/get?charts=summary_snapshot&start_date=2018-09-01&end_date=2020-10-13&format=txt

Query parameters

    charts = summary_snapshot
start_date = 2018-09-01
  end_date = 2020-10-13
    format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_summary_snapshot_type=line
result_summary_snapshot_series_0=ctas_visits
result_summary_snapshot_series_1=ctas_clicks
result_summary_snapshot_types_x=Ym
result_summary_snapshot_types_visits=int
result_summary_snapshot_types_clicks=int
result_summary_snapshot_data_ctas_visits_2018-09_visits=27
result_summary_snapshot_data_ctas_visits_2019-03_visits=27
result_summary_snapshot_data_ctas_visits_2020-02_visits=8
result_summary_snapshot_data_ctas_visits_2020-03_visits=6
result_summary_snapshot_data_ctas_visits_2020-05_visits=17
result_summary_snapshot_data_ctas_visits_2020-10_visits=17
result_summary_snapshot_data_ctas_clicks_2018-09_clicks=2
result_summary_snapshot_data_ctas_clicks_2019-03_clicks=2
result_summary_snapshot_data_ctas_clicks_2020-02_clicks=1
result_summary_snapshot_data_ctas_clicks_2020-03_clicks=1
result_summary_snapshot_data_ctas_clicks_2020-05_clicks=9
result_summary_snapshot_data_ctas_clicks_2020-10_clicks=2

Example 4 (plain)

Request

https://joturl.com/a/i1/stats/ctas/get?charts=summary_snapshot&start_date=2018-09-01&end_date=2020-10-13&format=plain

Query parameters

    charts = summary_snapshot
start_date = 2018-09-01
  end_date = 2020-10-13
    format = plain

Response

line
ctas_visits
ctas_clicks
Ym
int
int
27
27
8
6
17
17
2
2
1
1
9
2

Example 5 (json)

Request

https://joturl.com/a/i1/stats/ctas/get?cta_id=c408e4a4dd19fc741c96d89073eb7f6e&url_id=7e47f4fa6a157edbbd9ae4a36992e77f&charts=tl_cities&start_date=2020-10-01&end_date=2020-10-13

Query parameters

    cta_id = c408e4a4dd19fc741c96d89073eb7f6e
    url_id = 7e47f4fa6a157edbbd9ae4a36992e77f
    charts = tl_cities
start_date = 2020-10-01
  end_date = 2020-10-13

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "tl_cities": {
      "type": "doughnut",
      "series": [
        "cities"
      ],
      "types": {
        "count": "int"
      },
      "data": {
        "cities": {
          "Akko": {
            "count": 2
          },
          "Florence": {
            "count": 2
          }
        }
      },
      "table": {
        "Akko": {
          "visits": 2,
          "unique_visits": 0,
          "mobile": 0,
          "unique_mobile": 0,
          "qrcode_scans": 0
        },
        "Florence": {
          "visits": 2,
          "unique_visits": 0,
          "mobile": 0,
          "unique_mobile": 0,
          "qrcode_scans": 0
        }
      }
    }
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/stats/ctas/get?cta_id=c408e4a4dd19fc741c96d89073eb7f6e&url_id=7e47f4fa6a157edbbd9ae4a36992e77f&charts=tl_cities&start_date=2020-10-01&end_date=2020-10-13&format=xml

Query parameters

    cta_id = c408e4a4dd19fc741c96d89073eb7f6e
    url_id = 7e47f4fa6a157edbbd9ae4a36992e77f
    charts = tl_cities
start_date = 2020-10-01
  end_date = 2020-10-13
    format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <tl_cities>
      <type>doughnut</type>  
      <series>
        <i0>cities</i0>  
      </series>  
      <types>
        <count>int</count>  
      </types>  
      <data>
        <cities>
          <Akko>
            <count>2</count>  
          </Akko>  
          <Florence>
            <count>2</count>  
          </Florence>  
        </cities>  
      </data>  
      <table>
        <Akko>
          <visits>2</visits>  
          <unique_visits>0</unique_visits>  
          <mobile>0</mobile>  
          <unique_mobile>0</unique_mobile>  
          <qrcode_scans>0</qrcode_scans>  
        </Akko>  
        <Florence>
          <visits>2</visits>  
          <unique_visits>0</unique_visits>  
          <mobile>0</mobile>  
          <unique_mobile>0</unique_mobile>  
          <qrcode_scans>0</qrcode_scans>  
        </Florence>  
      </table>  
    </tl_cities>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/stats/ctas/get?cta_id=c408e4a4dd19fc741c96d89073eb7f6e&url_id=7e47f4fa6a157edbbd9ae4a36992e77f&charts=tl_cities&start_date=2020-10-01&end_date=2020-10-13&format=txt

Query parameters

    cta_id = c408e4a4dd19fc741c96d89073eb7f6e
    url_id = 7e47f4fa6a157edbbd9ae4a36992e77f
    charts = tl_cities
start_date = 2020-10-01
  end_date = 2020-10-13
    format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_tl_cities_type=doughnut
result_tl_cities_series_0=cities
result_tl_cities_types_count=int
result_tl_cities_data_cities_Akko_count=2
result_tl_cities_data_cities_Florence_count=2
result_tl_cities_table_Akko_visits=2
result_tl_cities_table_Akko_unique_visits=0
result_tl_cities_table_Akko_mobile=0
result_tl_cities_table_Akko_unique_mobile=0
result_tl_cities_table_Akko_qrcode_scans=0
result_tl_cities_table_Florence_visits=2
result_tl_cities_table_Florence_unique_visits=0
result_tl_cities_table_Florence_mobile=0
result_tl_cities_table_Florence_unique_mobile=0
result_tl_cities_table_Florence_qrcode_scans=0

Example 8 (plain)

Request

https://joturl.com/a/i1/stats/ctas/get?cta_id=c408e4a4dd19fc741c96d89073eb7f6e&url_id=7e47f4fa6a157edbbd9ae4a36992e77f&charts=tl_cities&start_date=2020-10-01&end_date=2020-10-13&format=plain

Query parameters

    cta_id = c408e4a4dd19fc741c96d89073eb7f6e
    url_id = 7e47f4fa6a157edbbd9ae4a36992e77f
    charts = tl_cities
start_date = 2020-10-01
  end_date = 2020-10-13
    format = plain

Response

doughnut
cities
int
2
2
2
0
0
0
0
2
0
0
0
0

Example 9 (json)

Request

https://joturl.com/a/i1/stats/ctas/get?cta_id=75b27fd2ea1a403c3a3dfc3ad83f0f86&url_id=54b388f72c5f0bdf3a02b658f1a4006b&charts=tl_ips&start_date=2020-10-01&end_date=2020-10-13

Query parameters

    cta_id = 75b27fd2ea1a403c3a3dfc3ad83f0f86
    url_id = 54b388f72c5f0bdf3a02b658f1a4006b
    charts = tl_ips
start_date = 2020-10-01
  end_date = 2020-10-13

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "tl_ips": {
      "nodata": 1
    }
  }
}

Example 10 (xml)

Request

https://joturl.com/a/i1/stats/ctas/get?cta_id=75b27fd2ea1a403c3a3dfc3ad83f0f86&url_id=54b388f72c5f0bdf3a02b658f1a4006b&charts=tl_ips&start_date=2020-10-01&end_date=2020-10-13&format=xml

Query parameters

    cta_id = 75b27fd2ea1a403c3a3dfc3ad83f0f86
    url_id = 54b388f72c5f0bdf3a02b658f1a4006b
    charts = tl_ips
start_date = 2020-10-01
  end_date = 2020-10-13
    format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <tl_ips>
      <nodata>1</nodata>  
    </tl_ips>  
  </result>  
</response>

Example 11 (txt)

Request

https://joturl.com/a/i1/stats/ctas/get?cta_id=75b27fd2ea1a403c3a3dfc3ad83f0f86&url_id=54b388f72c5f0bdf3a02b658f1a4006b&charts=tl_ips&start_date=2020-10-01&end_date=2020-10-13&format=txt

Query parameters

    cta_id = 75b27fd2ea1a403c3a3dfc3ad83f0f86
    url_id = 54b388f72c5f0bdf3a02b658f1a4006b
    charts = tl_ips
start_date = 2020-10-01
  end_date = 2020-10-13
    format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_tl_ips_nodata=1

Example 12 (plain)

Request

https://joturl.com/a/i1/stats/ctas/get?cta_id=75b27fd2ea1a403c3a3dfc3ad83f0f86&url_id=54b388f72c5f0bdf3a02b658f1a4006b&charts=tl_ips&start_date=2020-10-01&end_date=2020-10-13&format=plain

Query parameters

    cta_id = 75b27fd2ea1a403c3a3dfc3ad83f0f86
    url_id = 54b388f72c5f0bdf3a02b658f1a4006b
    charts = tl_ips
start_date = 2020-10-01
  end_date = 2020-10-13
    format = plain

Response

1
Required parameters
parameterdescription
chartsARRAYcomma separated list of charts, for a detailed list of charts see i1/stats/ctas/info
Optional parameters
parameterdescription
cta_idIDID of the CTA for which to extract statistics
end_dateDATEextract statistics up to this date (included)
map_typeSTRINGused only when charts contains tl_map, see i1/stats/projects/get for details
start_dateDATEextract statistics from this date (included)
url_idIDID of the tracking link for which to extract statistics
Return values
parameterdescription
dataJSON object in the format {"chart": {[CHART INFO]}}

/stats/ctas/info

access: [READ]

This method returns information about stats.

Example 1 (json)

Request

https://joturl.com/a/i1/stats/ctas/info?cta_id=4ee313835ec2b71c514a3281b19a4a95&url_id=28778612f9e66b659bf1145796d3fa8e

Query parameters

cta_id = 4ee313835ec2b71c514a3281b19a4a95
url_id = 28778612f9e66b659bf1145796d3fa8e

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": [
    "tl_snapshot",
    "tl_map",
    "tl_countries",
    "tl_regions",
    "tl_cities",
    "tl_languages",
    "tl_referrers",
    "tl_devices",
    "tl_browsers",
    "tl_platforms",
    "tl_operating_systems",
    "tl_ips",
    "tl_bots",
    "tl_ctas_conversions",
    "tl_ctas_metrics"
  ]
}

Example 2 (xml)

Request

https://joturl.com/a/i1/stats/ctas/info?cta_id=4ee313835ec2b71c514a3281b19a4a95&url_id=28778612f9e66b659bf1145796d3fa8e&format=xml

Query parameters

cta_id = 4ee313835ec2b71c514a3281b19a4a95
url_id = 28778612f9e66b659bf1145796d3fa8e
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <i0>tl_snapshot</i0>  
    <i1>tl_map</i1>  
    <i2>tl_countries</i2>  
    <i3>tl_regions</i3>  
    <i4>tl_cities</i4>  
    <i5>tl_languages</i5>  
    <i6>tl_referrers</i6>  
    <i7>tl_devices</i7>  
    <i8>tl_browsers</i8>  
    <i9>tl_platforms</i9>  
    <i10>tl_operating_systems</i10>  
    <i11>tl_ips</i11>  
    <i12>tl_bots</i12>  
    <i13>tl_ctas_conversions</i13>  
    <i14>tl_ctas_metrics</i14>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/stats/ctas/info?cta_id=4ee313835ec2b71c514a3281b19a4a95&url_id=28778612f9e66b659bf1145796d3fa8e&format=txt

Query parameters

cta_id = 4ee313835ec2b71c514a3281b19a4a95
url_id = 28778612f9e66b659bf1145796d3fa8e
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_0=tl_snapshot
result_1=tl_map
result_2=tl_countries
result_3=tl_regions
result_4=tl_cities
result_5=tl_languages
result_6=tl_referrers
result_7=tl_devices
result_8=tl_browsers
result_9=tl_platforms
result_10=tl_operating_systems
result_11=tl_ips
result_12=tl_bots
result_13=tl_ctas_conversions
result_14=tl_ctas_metrics

Example 4 (plain)

Request

https://joturl.com/a/i1/stats/ctas/info?cta_id=4ee313835ec2b71c514a3281b19a4a95&url_id=28778612f9e66b659bf1145796d3fa8e&format=plain

Query parameters

cta_id = 4ee313835ec2b71c514a3281b19a4a95
url_id = 28778612f9e66b659bf1145796d3fa8e
format = plain

Response

tl_snapshot
tl_map
tl_countries
tl_regions
tl_cities
tl_languages
tl_referrers
tl_devices
tl_browsers
tl_platforms
tl_operating_systems
tl_ips
tl_bots
tl_ctas_conversions
tl_ctas_metrics

Example 5 (json)

Request

https://joturl.com/a/i1/stats/ctas/info?cta_id=f175df97d916a10e27fb4c7136c7742f

Query parameters

cta_id = f175df97d916a10e27fb4c7136c7742f

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": [
    "summary_snapshot",
    "summary_conversions",
    "summary_commissions",
    "summary_ctas",
    "summary_cta_forms",
    "summary_cta_social_connects",
    "summary_clicks_to_destination",
    "tl_ctas_conversions",
    "tl_ctas_metrics"
  ]
}

Example 6 (xml)

Request

https://joturl.com/a/i1/stats/ctas/info?cta_id=f175df97d916a10e27fb4c7136c7742f&format=xml

Query parameters

cta_id = f175df97d916a10e27fb4c7136c7742f
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <i0>summary_snapshot</i0>  
    <i1>summary_conversions</i1>  
    <i2>summary_commissions</i2>  
    <i3>summary_ctas</i3>  
    <i4>summary_cta_forms</i4>  
    <i5>summary_cta_social_connects</i5>  
    <i6>summary_clicks_to_destination</i6>  
    <i7>tl_ctas_conversions</i7>  
    <i8>tl_ctas_metrics</i8>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/stats/ctas/info?cta_id=f175df97d916a10e27fb4c7136c7742f&format=txt

Query parameters

cta_id = f175df97d916a10e27fb4c7136c7742f
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_0=summary_snapshot
result_1=summary_conversions
result_2=summary_commissions
result_3=summary_ctas
result_4=summary_cta_forms
result_5=summary_cta_social_connects
result_6=summary_clicks_to_destination
result_7=tl_ctas_conversions
result_8=tl_ctas_metrics

Example 8 (plain)

Request

https://joturl.com/a/i1/stats/ctas/info?cta_id=f175df97d916a10e27fb4c7136c7742f&format=plain

Query parameters

cta_id = f175df97d916a10e27fb4c7136c7742f
format = plain

Response

summary_snapshot
summary_conversions
summary_commissions
summary_ctas
summary_cta_forms
summary_cta_social_connects
summary_clicks_to_destination
tl_ctas_conversions
tl_ctas_metrics

Example 9 (json)

Request

https://joturl.com/a/i1/stats/ctas/info

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": [
    "summary_snapshot"
  ]
}

Example 10 (xml)

Request

https://joturl.com/a/i1/stats/ctas/info?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <i0>summary_snapshot</i0>  
  </result>  
</response>

Example 11 (txt)

Request

https://joturl.com/a/i1/stats/ctas/info?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_0=summary_snapshot

Example 12 (plain)

Request

https://joturl.com/a/i1/stats/ctas/info?format=plain

Query parameters

format = plain

Response

summary_snapshot
Optional parameters
parameterdescription
cta_idIDID of the CTA for which to extract statistics
url_idIDID of the tracking link for which to extract statistics
Return values
parameterdescription
dataarray of available charts for the given cta_id and url_id

/stats/projects

/stats/projects/get

access: [READ]

This method returns the charts requested in the charts parameter.

Example 1 (json)

Request

https://joturl.com/a/i1/stats/projects/get?charts=summary_snapshot&start_date=2020-10-05&end_date=2020-10-11

Query parameters

    charts = summary_snapshot
start_date = 2020-10-05
  end_date = 2020-10-11

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "summary_snapshot": {
      "type": "line",
      "series": [
        "visits",
        "unique_visits",
        "mobile",
        "unique_mobile",
        "qrcode_scans"
      ],
      "types": {
        "x": "Ymd",
        "count": "int"
      },
      "data": {
        "visits": {
          "2020-10-05": {
            "count": 2
          },
          ...: {
            "count": 3
          },
          "2020-10-11": {
            "count": 19
          }
        },
        "unique_visits": {
          "2020-10-05": {
            "count": 2
          },
          ...: {
            "count": 3
          },
          "2020-10-11": {
            "count": 5
          }
        },
        "mobile": {
          "2020-10-05": {
            "count": 0
          },
          ...: {
            "count": 2
          },
          "2020-10-11": {
            "count": 0
          }
        },
        "unique_mobile": {
          "2020-10-05": {
            "count": 0
          },
          ...: {
            "count": 2
          },
          "2020-10-11": {
            "count": 0
          }
        },
        "qrcode_scans": {
          "2020-10-05": {
            "count": 0
          },
          ...: {
            "count": 0
          },
          "2020-10-11": {
            "count": 0
          }
        }
      }
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/stats/projects/get?charts=summary_snapshot&start_date=2020-10-05&end_date=2020-10-11&format=xml

Query parameters

    charts = summary_snapshot
start_date = 2020-10-05
  end_date = 2020-10-11
    format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <summary_snapshot>
      <type>line</type>  
      <series>
        <i0>visits</i0>  
        <i1>unique_visits</i1>  
        <i2>mobile</i2>  
        <i3>unique_mobile</i3>  
        <i4>qrcode_scans</i4>  
      </series>  
      <types>
        <x>Ymd</x>  
        <count>int</count>  
      </types>  
      <data>
        <visits>
          <2020-10-05>
            <count>2</count>  
          </2020-10-05>  
          <...>
            <count>3</count>  
          </...>  
          <2020-10-11>
            <count>19</count>  
          </2020-10-11>  
        </visits>  
        <unique_visits>
          <2020-10-05>
            <count>2</count>  
          </2020-10-05>  
          <...>
            <count>3</count>  
          </...>  
          <2020-10-11>
            <count>5</count>  
          </2020-10-11>  
        </unique_visits>  
        <mobile>
          <2020-10-05>
            <count>0</count>  
          </2020-10-05>  
          <...>
            <count>2</count>  
          </...>  
          <2020-10-11>
            <count>0</count>  
          </2020-10-11>  
        </mobile>  
        <unique_mobile>
          <2020-10-05>
            <count>0</count>  
          </2020-10-05>  
          <...>
            <count>2</count>  
          </...>  
          <2020-10-11>
            <count>0</count>  
          </2020-10-11>  
        </unique_mobile>  
        <qrcode_scans>
          <2020-10-05>
            <count>0</count>  
          </2020-10-05>  
          <...>
            <count>0</count>  
          </...>  
          <2020-10-11>
            <count>0</count>  
          </2020-10-11>  
        </qrcode_scans>  
      </data>  
    </summary_snapshot>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/stats/projects/get?charts=summary_snapshot&start_date=2020-10-05&end_date=2020-10-11&format=txt

Query parameters

    charts = summary_snapshot
start_date = 2020-10-05
  end_date = 2020-10-11
    format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_summary_snapshot_type=line
result_summary_snapshot_series_0=visits
result_summary_snapshot_series_1=unique_visits
result_summary_snapshot_series_2=mobile
result_summary_snapshot_series_3=unique_mobile
result_summary_snapshot_series_4=qrcode_scans
result_summary_snapshot_types_x=Ymd
result_summary_snapshot_types_count=int
result_summary_snapshot_data_visits_2020-10-05_count=2
result_summary_snapshot_data_visits_..._count=3
result_summary_snapshot_data_visits_2020-10-11_count=19
result_summary_snapshot_data_unique_visits_2020-10-05_count=2
result_summary_snapshot_data_unique_visits_..._count=3
result_summary_snapshot_data_unique_visits_2020-10-11_count=5
result_summary_snapshot_data_mobile_2020-10-05_count=0
result_summary_snapshot_data_mobile_..._count=2
result_summary_snapshot_data_mobile_2020-10-11_count=0
result_summary_snapshot_data_unique_mobile_2020-10-05_count=0
result_summary_snapshot_data_unique_mobile_..._count=2
result_summary_snapshot_data_unique_mobile_2020-10-11_count=0
result_summary_snapshot_data_qrcode_scans_2020-10-05_count=0
result_summary_snapshot_data_qrcode_scans_..._count=0
result_summary_snapshot_data_qrcode_scans_2020-10-11_count=0

Example 4 (plain)

Request

https://joturl.com/a/i1/stats/projects/get?charts=summary_snapshot&start_date=2020-10-05&end_date=2020-10-11&format=plain

Query parameters

    charts = summary_snapshot
start_date = 2020-10-05
  end_date = 2020-10-11
    format = plain

Response

line
visits
unique_visits
mobile
unique_mobile
qrcode_scans
Ymd
int
2
3
19
2
3
5
0
2
0
0
2
0
0
0
0

Example 5 (json)

Request

https://joturl.com/a/i1/stats/projects/get?project_id=85133b200ab54f78ef8562ac8e7649cf&url_id=2cfd6f97f72d38d20f9c0768fa6e69a5&charts=tl_browsers&start_date=2017-10-12&end_date=2020-10-12

Query parameters

project_id = 85133b200ab54f78ef8562ac8e7649cf
    url_id = 2cfd6f97f72d38d20f9c0768fa6e69a5
    charts = tl_browsers
start_date = 2017-10-12
  end_date = 2020-10-12

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "tl_browsers": {
      "type": "doughnut",
      "series": [
        "stats_browsers"
      ],
      "types": {
        "count": "int"
      },
      "data": {
        "stats_browsers": {
          "Internet Explorer": {
            "count": 15
          },
          "Mozilla": {
            "count": 14
          },
          ...: {
            "count": 13
          },
          "Internet Explorer Mobile": {
            "count": 4
          }
        }
      },
      "table": {
        "Internet Explorer": {
          "visits": 15,
          "unique_visits": 15,
          "mobile": 0,
          "unique_mobile": 0,
          "qrcode_scans": 0
        },
        "Mozilla": {
          "visits": 14,
          "unique_visits": 14,
          "mobile": 0,
          "unique_mobile": 0,
          "qrcode_scans": 0
        },
        ...: {
          "visits": 13,
          "unique_visits": 13,
          "mobile": 0,
          "unique_mobile": 0,
          "qrcode_scans": 0
        },
        "Internet Explorer Mobile": {
          "visits": 4,
          "unique_visits": 3,
          "mobile": 2,
          "unique_mobile": 1,
          "qrcode_scans": 1
        }
      }
    }
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/stats/projects/get?project_id=85133b200ab54f78ef8562ac8e7649cf&url_id=2cfd6f97f72d38d20f9c0768fa6e69a5&charts=tl_browsers&start_date=2017-10-12&end_date=2020-10-12&format=xml

Query parameters

project_id = 85133b200ab54f78ef8562ac8e7649cf
    url_id = 2cfd6f97f72d38d20f9c0768fa6e69a5
    charts = tl_browsers
start_date = 2017-10-12
  end_date = 2020-10-12
    format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <tl_browsers>
      <type>doughnut</type>  
      <series>
        <i0>stats_browsers</i0>  
      </series>  
      <types>
        <count>int</count>  
      </types>  
      <data>
        <stats_browsers>
          <Internet Explorer>
            <count>15</count>  
          </Internet Explorer>  
          <Mozilla>
            <count>14</count>  
          </Mozilla>  
          <...>
            <count>13</count>  
          </...>  
          <Internet Explorer Mobile>
            <count>4</count>  
          </Internet Explorer Mobile>  
        </stats_browsers>  
      </data>  
      <table>
        <Internet Explorer>
          <visits>15</visits>  
          <unique_visits>15</unique_visits>  
          <mobile>0</mobile>  
          <unique_mobile>0</unique_mobile>  
          <qrcode_scans>0</qrcode_scans>  
        </Internet Explorer>  
        <Mozilla>
          <visits>14</visits>  
          <unique_visits>14</unique_visits>  
          <mobile>0</mobile>  
          <unique_mobile>0</unique_mobile>  
          <qrcode_scans>0</qrcode_scans>  
        </Mozilla>  
        <...>
          <visits>13</visits>  
          <unique_visits>13</unique_visits>  
          <mobile>0</mobile>  
          <unique_mobile>0</unique_mobile>  
          <qrcode_scans>0</qrcode_scans>  
        </...>  
        <Internet Explorer Mobile>
          <visits>4</visits>  
          <unique_visits>3</unique_visits>  
          <mobile>2</mobile>  
          <unique_mobile>1</unique_mobile>  
          <qrcode_scans>1</qrcode_scans>  
        </Internet Explorer Mobile>  
      </table>  
    </tl_browsers>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/stats/projects/get?project_id=85133b200ab54f78ef8562ac8e7649cf&url_id=2cfd6f97f72d38d20f9c0768fa6e69a5&charts=tl_browsers&start_date=2017-10-12&end_date=2020-10-12&format=txt

Query parameters

project_id = 85133b200ab54f78ef8562ac8e7649cf
    url_id = 2cfd6f97f72d38d20f9c0768fa6e69a5
    charts = tl_browsers
start_date = 2017-10-12
  end_date = 2020-10-12
    format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_tl_browsers_type=doughnut
result_tl_browsers_series_0=stats_browsers
result_tl_browsers_types_count=int
result_tl_browsers_data_stats_browsers_Internet Explorer_count=15
result_tl_browsers_data_stats_browsers_Mozilla_count=14
result_tl_browsers_data_stats_browsers_..._count=13
result_tl_browsers_data_stats_browsers_Internet Explorer Mobile_count=4
result_tl_browsers_table_Internet Explorer_visits=15
result_tl_browsers_table_Internet Explorer_unique_visits=15
result_tl_browsers_table_Internet Explorer_mobile=0
result_tl_browsers_table_Internet Explorer_unique_mobile=0
result_tl_browsers_table_Internet Explorer_qrcode_scans=0
result_tl_browsers_table_Mozilla_visits=14
result_tl_browsers_table_Mozilla_unique_visits=14
result_tl_browsers_table_Mozilla_mobile=0
result_tl_browsers_table_Mozilla_unique_mobile=0
result_tl_browsers_table_Mozilla_qrcode_scans=0
result_tl_browsers_table_..._visits=13
result_tl_browsers_table_..._unique_visits=13
result_tl_browsers_table_..._mobile=0
result_tl_browsers_table_..._unique_mobile=0
result_tl_browsers_table_..._qrcode_scans=0
result_tl_browsers_table_Internet Explorer Mobile_visits=4
result_tl_browsers_table_Internet Explorer Mobile_unique_visits=3
result_tl_browsers_table_Internet Explorer Mobile_mobile=2
result_tl_browsers_table_Internet Explorer Mobile_unique_mobile=1
result_tl_browsers_table_Internet Explorer Mobile_qrcode_scans=1

Example 8 (plain)

Request

https://joturl.com/a/i1/stats/projects/get?project_id=85133b200ab54f78ef8562ac8e7649cf&url_id=2cfd6f97f72d38d20f9c0768fa6e69a5&charts=tl_browsers&start_date=2017-10-12&end_date=2020-10-12&format=plain

Query parameters

project_id = 85133b200ab54f78ef8562ac8e7649cf
    url_id = 2cfd6f97f72d38d20f9c0768fa6e69a5
    charts = tl_browsers
start_date = 2017-10-12
  end_date = 2020-10-12
    format = plain

Response

doughnut
stats_browsers
int
15
14
13
4
15
15
0
0
0
14
14
0
0
0
13
13
0
0
0
4
3
2
1
1

Example 9 (json)

Request

https://joturl.com/a/i1/stats/projects/get?charts=summary_clicks_to_destination&start_date=2017-10-12&end_date=2020-10-11

Query parameters

    charts = summary_clicks_to_destination
start_date = 2017-10-12
  end_date = 2020-10-11

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": []
}

Example 10 (xml)

Request

https://joturl.com/a/i1/stats/projects/get?charts=summary_clicks_to_destination&start_date=2017-10-12&end_date=2020-10-11&format=xml

Query parameters

    charts = summary_clicks_to_destination
start_date = 2017-10-12
  end_date = 2020-10-11
    format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>

  </result>  
</response>

Example 11 (txt)

Request

https://joturl.com/a/i1/stats/projects/get?charts=summary_clicks_to_destination&start_date=2017-10-12&end_date=2020-10-11&format=txt

Query parameters

    charts = summary_clicks_to_destination
start_date = 2017-10-12
  end_date = 2020-10-11
    format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result=

Example 12 (plain)

Request

https://joturl.com/a/i1/stats/projects/get?charts=summary_clicks_to_destination&start_date=2017-10-12&end_date=2020-10-11&format=plain

Query parameters

    charts = summary_clicks_to_destination
start_date = 2017-10-12
  end_date = 2020-10-11
    format = plain

Response

Example 13 (json)

Request

https://joturl.com/a/i1/stats/projects/get?cta_id=1e6f74529c85417b3dc59d835c352237&url_id=21d47207351a9018dfa35a71a6eb61e3&charts=tl_referrers&start_date=2020-10-01&end_date=2020-10-13

Query parameters

    cta_id = 1e6f74529c85417b3dc59d835c352237
    url_id = 21d47207351a9018dfa35a71a6eb61e3
    charts = tl_referrers
start_date = 2020-10-01
  end_date = 2020-10-13

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "tl_referrers": {
      "nodata": 1
    }
  }
}

Example 14 (xml)

Request

https://joturl.com/a/i1/stats/projects/get?cta_id=1e6f74529c85417b3dc59d835c352237&url_id=21d47207351a9018dfa35a71a6eb61e3&charts=tl_referrers&start_date=2020-10-01&end_date=2020-10-13&format=xml

Query parameters

    cta_id = 1e6f74529c85417b3dc59d835c352237
    url_id = 21d47207351a9018dfa35a71a6eb61e3
    charts = tl_referrers
start_date = 2020-10-01
  end_date = 2020-10-13
    format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <tl_referrers>
      <nodata>1</nodata>  
    </tl_referrers>  
  </result>  
</response>

Example 15 (txt)

Request

https://joturl.com/a/i1/stats/projects/get?cta_id=1e6f74529c85417b3dc59d835c352237&url_id=21d47207351a9018dfa35a71a6eb61e3&charts=tl_referrers&start_date=2020-10-01&end_date=2020-10-13&format=txt

Query parameters

    cta_id = 1e6f74529c85417b3dc59d835c352237
    url_id = 21d47207351a9018dfa35a71a6eb61e3
    charts = tl_referrers
start_date = 2020-10-01
  end_date = 2020-10-13
    format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_tl_referrers_nodata=1

Example 16 (plain)

Request

https://joturl.com/a/i1/stats/projects/get?cta_id=1e6f74529c85417b3dc59d835c352237&url_id=21d47207351a9018dfa35a71a6eb61e3&charts=tl_referrers&start_date=2020-10-01&end_date=2020-10-13&format=plain

Query parameters

    cta_id = 1e6f74529c85417b3dc59d835c352237
    url_id = 21d47207351a9018dfa35a71a6eb61e3
    charts = tl_referrers
start_date = 2020-10-01
  end_date = 2020-10-13
    format = plain

Response

1
Required parameters
parameterdescription
chartsARRAYcomma separated list of charts, for a detailed list of charts see i1/stats/projects/info
Optional parameters
parameterdescription
end_dateDATEextract statistics up to this date (included)
map_typeSTRINGused only when charts contains tl_map, see before for details
mu_idxINTEGERonly valid for tracking links with the InstaUrl option enabled, it allows you to specify the extraction of a specific URL: this value is the index of the corresponding URL in the option (in the same order in which they appear)
project_idIDID of the project for which to extract statistics
start_dateDATEextract statistics from this date (included)
url_idIDID of the tracking link for which to extract statistics
Return values
parameterdescription
dataJSON object in the format {"chart": {[CHART INFO]}}

/stats/projects/info

access: [READ]

This method returns available charts for the given inputs.

Example 1 (json)

Request

https://joturl.com/a/i1/stats/projects/info?project_id=6876f9151e33beddacbd81aec1b20bd8&url_id=6bf53872613cd6bed36f7c52b5f690ee

Query parameters

project_id = 6876f9151e33beddacbd81aec1b20bd8
    url_id = 6bf53872613cd6bed36f7c52b5f690ee

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": [
    "tl_snapshot",
    "tl_map",
    "tl_countries",
    "tl_regions",
    "tl_cities",
    "tl_languages",
    "tl_referrers",
    "tl_devices",
    "tl_browsers",
    "tl_platforms",
    "tl_operating_systems",
    "tl_ips",
    "tl_bots"
  ]
}

Example 2 (xml)

Request

https://joturl.com/a/i1/stats/projects/info?project_id=6876f9151e33beddacbd81aec1b20bd8&url_id=6bf53872613cd6bed36f7c52b5f690ee&format=xml

Query parameters

project_id = 6876f9151e33beddacbd81aec1b20bd8
    url_id = 6bf53872613cd6bed36f7c52b5f690ee
    format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <i0>tl_snapshot</i0>  
    <i1>tl_map</i1>  
    <i2>tl_countries</i2>  
    <i3>tl_regions</i3>  
    <i4>tl_cities</i4>  
    <i5>tl_languages</i5>  
    <i6>tl_referrers</i6>  
    <i7>tl_devices</i7>  
    <i8>tl_browsers</i8>  
    <i9>tl_platforms</i9>  
    <i10>tl_operating_systems</i10>  
    <i11>tl_ips</i11>  
    <i12>tl_bots</i12>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/stats/projects/info?project_id=6876f9151e33beddacbd81aec1b20bd8&url_id=6bf53872613cd6bed36f7c52b5f690ee&format=txt

Query parameters

project_id = 6876f9151e33beddacbd81aec1b20bd8
    url_id = 6bf53872613cd6bed36f7c52b5f690ee
    format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_0=tl_snapshot
result_1=tl_map
result_2=tl_countries
result_3=tl_regions
result_4=tl_cities
result_5=tl_languages
result_6=tl_referrers
result_7=tl_devices
result_8=tl_browsers
result_9=tl_platforms
result_10=tl_operating_systems
result_11=tl_ips
result_12=tl_bots

Example 4 (plain)

Request

https://joturl.com/a/i1/stats/projects/info?project_id=6876f9151e33beddacbd81aec1b20bd8&url_id=6bf53872613cd6bed36f7c52b5f690ee&format=plain

Query parameters

project_id = 6876f9151e33beddacbd81aec1b20bd8
    url_id = 6bf53872613cd6bed36f7c52b5f690ee
    format = plain

Response

tl_snapshot
tl_map
tl_countries
tl_regions
tl_cities
tl_languages
tl_referrers
tl_devices
tl_browsers
tl_platforms
tl_operating_systems
tl_ips
tl_bots

Example 5 (json)

Request

https://joturl.com/a/i1/stats/projects/info?project_id=31ae95cf59cc9496c7127c88306d7f06

Query parameters

project_id = 31ae95cf59cc9496c7127c88306d7f06

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": [
    "summary_snapshot",
    "summary_conversions",
    "summary_commissions",
    "summary_ctas",
    "summary_cta_forms",
    "summary_cta_social_connects",
    "summary_clicks_to_destination"
  ]
}

Example 6 (xml)

Request

https://joturl.com/a/i1/stats/projects/info?project_id=31ae95cf59cc9496c7127c88306d7f06&format=xml

Query parameters

project_id = 31ae95cf59cc9496c7127c88306d7f06
    format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <i0>summary_snapshot</i0>  
    <i1>summary_conversions</i1>  
    <i2>summary_commissions</i2>  
    <i3>summary_ctas</i3>  
    <i4>summary_cta_forms</i4>  
    <i5>summary_cta_social_connects</i5>  
    <i6>summary_clicks_to_destination</i6>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/stats/projects/info?project_id=31ae95cf59cc9496c7127c88306d7f06&format=txt

Query parameters

project_id = 31ae95cf59cc9496c7127c88306d7f06
    format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_0=summary_snapshot
result_1=summary_conversions
result_2=summary_commissions
result_3=summary_ctas
result_4=summary_cta_forms
result_5=summary_cta_social_connects
result_6=summary_clicks_to_destination

Example 8 (plain)

Request

https://joturl.com/a/i1/stats/projects/info?project_id=31ae95cf59cc9496c7127c88306d7f06&format=plain

Query parameters

project_id = 31ae95cf59cc9496c7127c88306d7f06
    format = plain

Response

summary_snapshot
summary_conversions
summary_commissions
summary_ctas
summary_cta_forms
summary_cta_social_connects
summary_clicks_to_destination

Example 9 (json)

Request

https://joturl.com/a/i1/stats/projects/info

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": [
    "summary_snapshot",
    "summary_conversions",
    "summary_commissions",
    "summary_ctas",
    "summary_cta_forms",
    "summary_cta_social_connects",
    "summary_clicks_to_destination",
    "summary_external_apis",
    "summary_short_domain_requests"
  ]
}

Example 10 (xml)

Request

https://joturl.com/a/i1/stats/projects/info?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <i0>summary_snapshot</i0>  
    <i1>summary_conversions</i1>  
    <i2>summary_commissions</i2>  
    <i3>summary_ctas</i3>  
    <i4>summary_cta_forms</i4>  
    <i5>summary_cta_social_connects</i5>  
    <i6>summary_clicks_to_destination</i6>  
    <i7>summary_external_apis</i7>  
    <i8>summary_short_domain_requests</i8>  
  </result>  
</response>

Example 11 (txt)

Request

https://joturl.com/a/i1/stats/projects/info?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_0=summary_snapshot
result_1=summary_conversions
result_2=summary_commissions
result_3=summary_ctas
result_4=summary_cta_forms
result_5=summary_cta_social_connects
result_6=summary_clicks_to_destination
result_7=summary_external_apis
result_8=summary_short_domain_requests

Example 12 (plain)

Request

https://joturl.com/a/i1/stats/projects/info?format=plain

Query parameters

format = plain

Response

summary_snapshot
summary_conversions
summary_commissions
summary_ctas
summary_cta_forms
summary_cta_social_connects
summary_clicks_to_destination
summary_external_apis
summary_short_domain_requests
Optional parameters
parameterdescription
project_idIDID of the project for which to extract statistics
url_idIDID of the tracking link for which to extract statistics
Return values
parameterdescription
dataarray of available charts for the given project_id and url_id

/subusers

/subusers/accounts

/subusers/accounts/count

access: [READ]

This method returns the number of accounts associated with the logged user.

Example 1 (json)

Request

https://joturl.com/a/i1/subusers/accounts/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 2
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/subusers/accounts/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>2</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/subusers/accounts/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=2

Example 4 (plain)

Request

https://joturl.com/a/i1/subusers/accounts/count?format=plain

Query parameters

format = plain

Response

2
Optional parameters
parameterdescription
searchSTRINGfilters associated accounts to be extracted by searching them
Return values
parameterdescription
counttotal number of associated accounts (filtered by parameter search)

/subusers/accounts/list

access: [READ]

This method returns a list of accounts associated with the logged user.

Example 1 (json)

Request

https://joturl.com/a/i1/subusers/accounts/list

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 2,
    "data": [
      {
        "id": "5faf37f6477b0075f8412c3b20067726",
        "current": 1,
        "full_name": "Jon Smith",
        "email": "jon.smith.198@example.com",
        "short_name": "JS",
        "is_readonly": 0,
        "is_subuser": 0,
        "parent_full_name": "",
        "parent_short_name": "",
        "has_access_to_dashboard": 1,
        "creation": "2026-02-27 16:53:14",
        "domains": []
      },
      {
        "id": "8f1dea0f8e51099bcf6284cdfefc09e9",
        "current": 0,
        "full_name": "Jon Smith (subuser)",
        "email": "jon.smith.198@example.com",
        "short_name": "JS",
        "is_readonly": 0,
        "is_subuser": 1,
        "parent_full_name": "Maria Garcia",
        "parent_short_name": "MG",
        "has_access_to_dashboard": 0,
        "creation": "2025-09-25 16:53:14",
        "domains": [
          "my.custom.domain"
        ]
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/subusers/accounts/list?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>2</count>  
    <data>
      <i0>
        <id>5faf37f6477b0075f8412c3b20067726</id>  
        <current>1</current>  
        <full_name>Jon Smith</full_name>  
        <email>jon.smith.198@example.com</email>  
        <short_name>JS</short_name>  
        <is_readonly>0</is_readonly>  
        <is_subuser>0</is_subuser>  
        <parent_full_name></parent_full_name>  
        <parent_short_name></parent_short_name>  
        <has_access_to_dashboard>1</has_access_to_dashboard>  
        <creation>2026-02-27 16:53:14</creation>  
        <domains>

        </domains>  
      </i0>  
      <i1>
        <id>8f1dea0f8e51099bcf6284cdfefc09e9</id>  
        <current>0</current>  
        <full_name>Jon Smith (subuser)</full_name>  
        <email>jon.smith.198@example.com</email>  
        <short_name>JS</short_name>  
        <is_readonly>0</is_readonly>  
        <is_subuser>1</is_subuser>  
        <parent_full_name>Maria Garcia</parent_full_name>  
        <parent_short_name>MG</parent_short_name>  
        <has_access_to_dashboard>0</has_access_to_dashboard>  
        <creation>2025-09-25 16:53:14</creation>  
        <domains>
          <i0>my.custom.domain</i0>  
        </domains>  
      </i1>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/subusers/accounts/list?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=2
result_data_0_id=5faf37f6477b0075f8412c3b20067726
result_data_0_current=1
result_data_0_full_name=Jon Smith
result_data_0_email=jon.smith.198@example.com
result_data_0_short_name=JS
result_data_0_is_readonly=0
result_data_0_is_subuser=0
result_data_0_parent_full_name=
result_data_0_parent_short_name=
result_data_0_has_access_to_dashboard=1
result_data_0_creation=2026-02-27 16:53:14
result_data_0_domains=
result_data_1_id=8f1dea0f8e51099bcf6284cdfefc09e9
result_data_1_current=0
result_data_1_full_name=Jon Smith (subuser)
result_data_1_email=jon.smith.198@example.com
result_data_1_short_name=JS
result_data_1_is_readonly=0
result_data_1_is_subuser=1
result_data_1_parent_full_name=Maria Garcia
result_data_1_parent_short_name=MG
result_data_1_has_access_to_dashboard=0
result_data_1_creation=2025-09-25 16:53:14
result_data_1_domains_0=my.custom.domain

Example 4 (plain)

Request

https://joturl.com/a/i1/subusers/accounts/list?format=plain

Query parameters

format = plain

Response

2
5faf37f6477b0075f8412c3b20067726
1
Jon Smith
jon.smith.198@example.com
JS
0
0


1
2026-02-27 16:53:14

8f1dea0f8e51099bcf6284cdfefc09e9
0
Jon Smith (subuser)
jon.smith.198@example.com
JS
0
1
Maria Garcia
MG
0
2025-09-25 16:53:14
my.custom.domain
Optional parameters
parameterdescription
searchSTRINGfilters associated accounts to be extracted by searching them
Return values
parameterdescription
counttotal number of associated accounts (filtered by parameter search)
dataarray containing information on the associated accounts

/subusers/accounts/swap

access: [READ]

This method allows the logged in user to access another account to which he/she has access.

Example 1 (json)

Request

https://joturl.com/a/i1/subusers/accounts/swap?id=398046b15c2d465aa343e20f1065524d

Query parameters

id = 398046b15c2d465aa343e20f1065524d

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "logged": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/subusers/accounts/swap?id=398046b15c2d465aa343e20f1065524d&format=xml

Query parameters

    id = 398046b15c2d465aa343e20f1065524d
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <logged>1</logged>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/subusers/accounts/swap?id=398046b15c2d465aa343e20f1065524d&format=txt

Query parameters

    id = 398046b15c2d465aa343e20f1065524d
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_logged=1

Example 4 (plain)

Request

https://joturl.com/a/i1/subusers/accounts/swap?id=398046b15c2d465aa343e20f1065524d&format=plain

Query parameters

    id = 398046b15c2d465aa343e20f1065524d
format = plain

Response

1
Required parameters
parameterdescription
idSTRINGID of the account to swap to, this ID can be obtained by calling i1/subusers/accounts/list
Return values
parameterdescription
logged1 on success, an invalid parameter error otherwise

/subusers/add

access: [WRITE]

This method adds a new team member.

Example 1 (json)

Request

https://joturl.com/a/i1/subusers/add?email=email.of%40the.team.member&full_name=full+name+of+the+team+member

Query parameters

    email = email.of@the.team.member
full_name = full name of the team member

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "email": "email.of@the.team.member",
    "full_name": "full name of the team member",
    "added": "1 on success, 0 otherwise",
    "id": "1713ad6104965c990ed013542cb870a0",
    "level": 5,
    "gender": "m",
    "role": "",
    "group": "",
    "creation": "2025-06-27 16:53:14",
    "is_readonly": 0,
    "is_confirmed": 0,
    "permission_id": null,
    "permission_name": null,
    "is_alias": 0,
    "alias_email": "",
    "alias_full_name": ""
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/subusers/add?email=email.of%40the.team.member&full_name=full+name+of+the+team+member&format=xml

Query parameters

    email = email.of@the.team.member
full_name = full name of the team member
   format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <email>email.of@the.team.member</email>  
    <full_name>full name of the team member</full_name>  
    <added>1 on success, 0 otherwise</added>  
    <id>1713ad6104965c990ed013542cb870a0</id>  
    <level>5</level>  
    <gender>m</gender>  
    <role></role>  
    <group></group>  
    <creation>2025-06-27 16:53:14</creation>  
    <is_readonly>0</is_readonly>  
    <is_confirmed>0</is_confirmed>  
    <permission_id></permission_id>  
    <permission_name></permission_name>  
    <is_alias>0</is_alias>  
    <alias_email></alias_email>  
    <alias_full_name></alias_full_name>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/subusers/add?email=email.of%40the.team.member&full_name=full+name+of+the+team+member&format=txt

Query parameters

    email = email.of@the.team.member
full_name = full name of the team member
   format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_email=email.of@the.team.member
result_full_name=full name of the team member
result_added=1 on success, 0 otherwise
result_id=1713ad6104965c990ed013542cb870a0
result_level=5
result_gender=m
result_role=
result_group=
result_creation=2025-06-27 16:53:14
result_is_readonly=0
result_is_confirmed=0
result_permission_id=
result_permission_name=
result_is_alias=0
result_alias_email=
result_alias_full_name=

Example 4 (plain)

Request

https://joturl.com/a/i1/subusers/add?email=email.of%40the.team.member&full_name=full+name+of+the+team+member&format=plain

Query parameters

    email = email.of@the.team.member
full_name = full name of the team member
   format = plain

Response

email.of@the.team.member
full name of the team member
1 on success, 0 otherwise
1713ad6104965c990ed013542cb870a0
5
m


2025-06-27 16:53:14
0
0


0


Required parameters
parameterdescriptionmax length
emailSTRINGemail address of the team member255
full_nameSTRINGfull name of the team member255
Optional parameters
parameterdescriptionmax length
genderSTRINGgender of the team member, possible values: [m, f], default: m1
groupSTRINGgroup of the team member50
is_aliasBOOLEAN1 if the user has full access to the account of the user who created it
is_readonlyBOOLEAN1 if the team member can only read information
locationSTRING2-digit code of the country (ISO Alpha-2) the team member is based on (e.g., US)50
permission_idIDID of the subuser permission (can only be passed by administrator/root users)
phone_numberSTRINGphone number255
roleSTRINGrole of the team member50
Return values
parameterdescription
added1 on success, 0 otherwise
alias_emailemail of the alias user if is_alias = 1, empty othrwise
alias_full_namefull name of the alias user if is_alias = 1, empty othrwise
creationcreation date/time
emailecho back of the email input parameter
full_nameecho back of the full_name input parameter
genderecho back of the gender input parameter
groupecho back of the group input parameter
idID of the team member
is_aliasecho back of the is_alias input parameter
is_confirmed1 if the team member confirmed the account by clicking on the confirmation link sent by email, 0 otherwise. The return value is always 0 when adding a new team member. Read the note below for details.
is_readonlyecho back of the is_readonly input parameter
levellevel of the team member (level represents the user hierarchy, parent users have a lower level than childrens)
permission_idID of the subuser permission (only returned for administrator/root users)
permission_namename of the subuser permission (only returned for administrator/root users)
roleecho back of the role input parameter

/subusers/count

access: [READ]

This method returns the number of team members.

Example 1 (json)

Request

https://joturl.com/a/i1/subusers/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 4
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/subusers/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>4</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/subusers/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=4

Example 4 (plain)

Request

https://joturl.com/a/i1/subusers/count?format=plain

Query parameters

format = plain

Response

4
Optional parameters
parameterdescription
searchSTRINGfilters team members to be extracted by searching them
with_projectsBOOLEAN1 to count only team members who created projects still present in the dashboard, 0 otherwise (default)
Return values
parameterdescription
countthe number of team members

/subusers/delete

access: [WRITE]

This method deletes a team member.

Example 1 (json)

Request

https://joturl.com/a/i1/subusers/delete?ids=38bd788f69b4b6f6ac64e7dd34a287ee,e18f4cc2e4009302561a5e4903d88008,a80c71ee4b7ef0a641d2f41b890a3eb9,cce2db091225cb1d6954cad9ac0e215b,ab5de7a8bb6f933f99a2ebd77aa3058a

Query parameters

ids = 38bd788f69b4b6f6ac64e7dd34a287ee,e18f4cc2e4009302561a5e4903d88008,a80c71ee4b7ef0a641d2f41b890a3eb9,cce2db091225cb1d6954cad9ac0e215b,ab5de7a8bb6f933f99a2ebd77aa3058a

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 5
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/subusers/delete?ids=38bd788f69b4b6f6ac64e7dd34a287ee,e18f4cc2e4009302561a5e4903d88008,a80c71ee4b7ef0a641d2f41b890a3eb9,cce2db091225cb1d6954cad9ac0e215b,ab5de7a8bb6f933f99a2ebd77aa3058a&format=xml

Query parameters

   ids = 38bd788f69b4b6f6ac64e7dd34a287ee,e18f4cc2e4009302561a5e4903d88008,a80c71ee4b7ef0a641d2f41b890a3eb9,cce2db091225cb1d6954cad9ac0e215b,ab5de7a8bb6f933f99a2ebd77aa3058a
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>5</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/subusers/delete?ids=38bd788f69b4b6f6ac64e7dd34a287ee,e18f4cc2e4009302561a5e4903d88008,a80c71ee4b7ef0a641d2f41b890a3eb9,cce2db091225cb1d6954cad9ac0e215b,ab5de7a8bb6f933f99a2ebd77aa3058a&format=txt

Query parameters

   ids = 38bd788f69b4b6f6ac64e7dd34a287ee,e18f4cc2e4009302561a5e4903d88008,a80c71ee4b7ef0a641d2f41b890a3eb9,cce2db091225cb1d6954cad9ac0e215b,ab5de7a8bb6f933f99a2ebd77aa3058a
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=5

Example 4 (plain)

Request

https://joturl.com/a/i1/subusers/delete?ids=38bd788f69b4b6f6ac64e7dd34a287ee,e18f4cc2e4009302561a5e4903d88008,a80c71ee4b7ef0a641d2f41b890a3eb9,cce2db091225cb1d6954cad9ac0e215b,ab5de7a8bb6f933f99a2ebd77aa3058a&format=plain

Query parameters

   ids = 38bd788f69b4b6f6ac64e7dd34a287ee,e18f4cc2e4009302561a5e4903d88008,a80c71ee4b7ef0a641d2f41b890a3eb9,cce2db091225cb1d6954cad9ac0e215b,ab5de7a8bb6f933f99a2ebd77aa3058a
format = plain

Response

5
Required parameters
parameterdescription
idsARRAY_OF_IDScomma-separated list of team members to remove
Return values
parameterdescription
deletednumber of deleted team members on success, 0 otherwise

/subusers/edit

access: [WRITE]

This method edits a team member.

Example 1 (json)

Request

https://joturl.com/a/i1/subusers/edit?full_name=new+full+name+of+the+team+member

Query parameters

full_name = new full name of the team member

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "full_name": "new full name of the team member",
    "updated": "1 on success, 0 otherwise",
    "id": "8e7f6dec834083407fbf732dc2a166ba",
    "is_alias": 0,
    "alias_email": "",
    "alias_full_name": ""
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/subusers/edit?full_name=new+full+name+of+the+team+member&format=xml

Query parameters

full_name = new full name of the team member
   format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <full_name>new full name of the team member</full_name>  
    <updated>1 on success, 0 otherwise</updated>  
    <id>8e7f6dec834083407fbf732dc2a166ba</id>  
    <is_alias>0</is_alias>  
    <alias_email></alias_email>  
    <alias_full_name></alias_full_name>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/subusers/edit?full_name=new+full+name+of+the+team+member&format=txt

Query parameters

full_name = new full name of the team member
   format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_full_name=new full name of the team member
result_updated=1 on success, 0 otherwise
result_id=8e7f6dec834083407fbf732dc2a166ba
result_is_alias=0
result_alias_email=
result_alias_full_name=

Example 4 (plain)

Request

https://joturl.com/a/i1/subusers/edit?full_name=new+full+name+of+the+team+member&format=plain

Query parameters

full_name = new full name of the team member
   format = plain

Response

new full name of the team member
1 on success, 0 otherwise
8e7f6dec834083407fbf732dc2a166ba
0


Required parameters
parameterdescription
idIDID of the team member
Optional parameters
parameterdescriptionmax length
full_nameSTRINGfull name of the team member255
genderSTRINGgender of the team member, possible values: [m, f], default: m1
groupSTRINGgroup of the team member50
is_aliasBOOLEAN1 if the user has full access to the account of the user who created it
is_confirmedBOOLEAN1 to enable the team member, 0 to disable
is_readonlyBOOLEAN1 if the team member can only read information
locationSTRING2-digit code of the country (ISO Alpha-2) the team member is based on (e.g., US)50
permission_idIDID of the subuser permission (can only be passed by administrator/root users)
phone_numberSTRINGphone number255
roleSTRINGrole of the team member50
Return values
parameterdescription
alias_emailemail of the alias user if is_alias = 1, empty otherwise
alias_full_namefull name of the alias user if is_alias = 1, empty otherwise
creation[OPTIONAL] creation date/time
full_name[OPTIONAL] echo back of the full_name input parameter
gender[OPTIONAL] echo back of the gender input parameter
group[OPTIONAL] echo back of the group input parameter
idID of the team member
is_aliasecho back of the is_alias input parameter
is_readonly[OPTIONAL] echo back of the is_readonly input parameter
location[OPTIONAL] echo back of the location input parameter
permission_idID of the subuser permission (only returned for administrator/root users)
permission_namename of the subuser permission (only returned for administrator/root users)
permissions_updatednumber of team members whose permissions were updated
phone_number[OPTIONAL] echo back of the phone_number input parameter
role[OPTIONAL] echo back of the role input parameter
updated1 on success, 0 otherwise

/subusers/info

access: [READ]

This method returns info about a team member.

Example 1 (json)

Request

https://joturl.com/a/i1/subusers/info?fields=parent_id,id,level,email,full_name,group,role,is_readonly,last_login,is_confirmed,permission_id,permission_name,is_alias&id=3deb4405364b0f9a4a590be421d00f0b

Query parameters

fields = parent_id,id,level,email,full_name,group,role,is_readonly,last_login,is_confirmed,permission_id,permission_name,is_alias
    id = 3deb4405364b0f9a4a590be421d00f0b

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": [
      {
        "parent_id": "fba38cd8d99dde595c9d3211180f7768",
        "id": "3deb4405364b0f9a4a590be421d00f0b",
        "level": 1,
        "email": "email.of@the.team.member",
        "full_name": "full name of the team member",
        "group": "",
        "role": "Tester",
        "is_readonly": 0,
        "last_login": "2025-06-27 16:53:14",
        "is_confirmed": 1,
        "permission_id": "8018f33625162aa03503f2a245075efc",
        "permission_name": "permission name",
        "is_alias": 0,
        "alias_email": "",
        "alias_full_name": ""
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/subusers/info?fields=parent_id,id,level,email,full_name,group,role,is_readonly,last_login,is_confirmed,permission_id,permission_name,is_alias&id=3deb4405364b0f9a4a590be421d00f0b&format=xml

Query parameters

fields = parent_id,id,level,email,full_name,group,role,is_readonly,last_login,is_confirmed,permission_id,permission_name,is_alias
    id = 3deb4405364b0f9a4a590be421d00f0b
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <i0>
        <parent_id>fba38cd8d99dde595c9d3211180f7768</parent_id>  
        <id>3deb4405364b0f9a4a590be421d00f0b</id>  
        <level>1</level>  
        <email>email.of@the.team.member</email>  
        <full_name>full name of the team member</full_name>  
        <group></group>  
        <role>Tester</role>  
        <is_readonly>0</is_readonly>  
        <last_login>2025-06-27 16:53:14</last_login>  
        <is_confirmed>1</is_confirmed>  
        <permission_id>8018f33625162aa03503f2a245075efc</permission_id>  
        <permission_name>permission name</permission_name>  
        <is_alias>0</is_alias>  
        <alias_email></alias_email>  
        <alias_full_name></alias_full_name>  
      </i0>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/subusers/info?fields=parent_id,id,level,email,full_name,group,role,is_readonly,last_login,is_confirmed,permission_id,permission_name,is_alias&id=3deb4405364b0f9a4a590be421d00f0b&format=txt

Query parameters

fields = parent_id,id,level,email,full_name,group,role,is_readonly,last_login,is_confirmed,permission_id,permission_name,is_alias
    id = 3deb4405364b0f9a4a590be421d00f0b
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_0_parent_id=fba38cd8d99dde595c9d3211180f7768
result_data_0_id=3deb4405364b0f9a4a590be421d00f0b
result_data_0_level=1
result_data_0_email=email.of@the.team.member
result_data_0_full_name=full name of the team member
result_data_0_group=
result_data_0_role=Tester
result_data_0_is_readonly=0
result_data_0_last_login=2025-06-27 16:53:14
result_data_0_is_confirmed=1
result_data_0_permission_id=8018f33625162aa03503f2a245075efc
result_data_0_permission_name=permission name
result_data_0_is_alias=0
result_data_0_alias_email=
result_data_0_alias_full_name=

Example 4 (plain)

Request

https://joturl.com/a/i1/subusers/info?fields=parent_id,id,level,email,full_name,group,role,is_readonly,last_login,is_confirmed,permission_id,permission_name,is_alias&id=3deb4405364b0f9a4a590be421d00f0b&format=plain

Query parameters

fields = parent_id,id,level,email,full_name,group,role,is_readonly,last_login,is_confirmed,permission_id,permission_name,is_alias
    id = 3deb4405364b0f9a4a590be421d00f0b
format = plain

Response

fba38cd8d99dde595c9d3211180f7768
3deb4405364b0f9a4a590be421d00f0b
1
email.of@the.team.member
full name of the team member

Tester
0
2025-06-27 16:53:14
1
8018f33625162aa03503f2a245075efc
permission name
0


Required parameters
parameterdescription
fieldsARRAYcomma-separated list of fields to return, available fields: count, is_confirmed, creation, email, full_name, gender, group, id, is_readonly, last_login, level, location, name, phone_number, role, parent_id
idIDID of the team member
Return values
parameterdescription
dataarray containing information on the team members, returned information depends on the fields parameter.

/subusers/list

access: [READ]

This method returns a list of team members.

Example 1 (json)

Request

https://joturl.com/a/i1/subusers/list?fields=count,parent_id,id,level,email,full_name,group,role,is_readonly,last_login,is_confirmed,permission_id,permission_name,is_alias

Query parameters

fields = count,parent_id,id,level,email,full_name,group,role,is_readonly,last_login,is_confirmed,permission_id,permission_name,is_alias

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 1,
    "data": [
      {
        "parent_id": "20d72d511aa3417356c82abe0d28da89",
        "id": "1f407794c8fecd42de22aa9e02680b8c",
        "level": 1,
        "email": "email.of@the.team.member",
        "full_name": "full name of the team member",
        "group": "",
        "role": "Tester",
        "is_readonly": 0,
        "last_login": "2025-06-27 16:53:14",
        "is_confirmed": 1,
        "permission_id": "fdc415ed5eafb661dd873ad4218f3e5b",
        "permission_name": "permission name",
        "is_alias": 0,
        "alias_email": "",
        "alias_full_name": ""
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/subusers/list?fields=count,parent_id,id,level,email,full_name,group,role,is_readonly,last_login,is_confirmed,permission_id,permission_name,is_alias&format=xml

Query parameters

fields = count,parent_id,id,level,email,full_name,group,role,is_readonly,last_login,is_confirmed,permission_id,permission_name,is_alias
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>1</count>  
    <data>
      <i0>
        <parent_id>20d72d511aa3417356c82abe0d28da89</parent_id>  
        <id>1f407794c8fecd42de22aa9e02680b8c</id>  
        <level>1</level>  
        <email>email.of@the.team.member</email>  
        <full_name>full name of the team member</full_name>  
        <group></group>  
        <role>Tester</role>  
        <is_readonly>0</is_readonly>  
        <last_login>2025-06-27 16:53:14</last_login>  
        <is_confirmed>1</is_confirmed>  
        <permission_id>fdc415ed5eafb661dd873ad4218f3e5b</permission_id>  
        <permission_name>permission name</permission_name>  
        <is_alias>0</is_alias>  
        <alias_email></alias_email>  
        <alias_full_name></alias_full_name>  
      </i0>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/subusers/list?fields=count,parent_id,id,level,email,full_name,group,role,is_readonly,last_login,is_confirmed,permission_id,permission_name,is_alias&format=txt

Query parameters

fields = count,parent_id,id,level,email,full_name,group,role,is_readonly,last_login,is_confirmed,permission_id,permission_name,is_alias
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=1
result_data_0_parent_id=20d72d511aa3417356c82abe0d28da89
result_data_0_id=1f407794c8fecd42de22aa9e02680b8c
result_data_0_level=1
result_data_0_email=email.of@the.team.member
result_data_0_full_name=full name of the team member
result_data_0_group=
result_data_0_role=Tester
result_data_0_is_readonly=0
result_data_0_last_login=2025-06-27 16:53:14
result_data_0_is_confirmed=1
result_data_0_permission_id=fdc415ed5eafb661dd873ad4218f3e5b
result_data_0_permission_name=permission name
result_data_0_is_alias=0
result_data_0_alias_email=
result_data_0_alias_full_name=

Example 4 (plain)

Request

https://joturl.com/a/i1/subusers/list?fields=count,parent_id,id,level,email,full_name,group,role,is_readonly,last_login,is_confirmed,permission_id,permission_name,is_alias&format=plain

Query parameters

fields = count,parent_id,id,level,email,full_name,group,role,is_readonly,last_login,is_confirmed,permission_id,permission_name,is_alias
format = plain

Response

1
20d72d511aa3417356c82abe0d28da89
1f407794c8fecd42de22aa9e02680b8c
1
email.of@the.team.member
full name of the team member

Tester
0
2025-06-27 16:53:14
1
fdc415ed5eafb661dd873ad4218f3e5b
permission name
0


Required parameters
parameterdescription
fieldsARRAYcomma-separated list of fields to return, available fields: count, is_confirmed, creation, email, full_name, gender, group, id, is_readonly, last_login, level, location, name, phone_number, role, parent_id
Optional parameters
parameterdescription
lengthINTEGERextracts this number of team members (maxmimum allowed: 100)
orderbyARRAYorders team members by field, available fields: is_confirmed, creation, email, full_name, gender, group, id, is_readonly, last_login, level, location, name, phone_number, role, parent_id
project_idIDID of the project, when passed the field has_access is returned for each team member, has_access = 1 if the team member has access to the project, has_access = 0 otherwise
searchSTRINGfilters team members to be extracted by searching them
sortSTRINGsorts team members in ascending (ASC) or descending (DESC) order
startINTEGERstarts to extract team members from this position
with_projectsBOOLEAN1 to extract only team members who created projects still present in the dashboard, 0 otherwise (default)
Return values
parameterdescription
count[OPTIONAL] total number of team members, returned only if count is passed in fields
dataarray containing information on the team members, returned information depends on the fields parameter.

/subusers/projects

/subusers/projects/grant

access: [WRITE]

Grants access to projects to the team member.

Example 1 (json)

Request

https://joturl.com/a/i1/subusers/projects/grant?id=14a30648f3d37d6429baf30d3975f076&add_ids=f7d135c13b033407c35278250895a310,e7376754d40dc62b237edbe576ba9d74&delete_ids=c6d62e4c9b8d68c3f23b9e07095b0f61,96cc0393a34817294da77c3fcf91fe97,18e9c98160ea37743b43e88bef91e1e2,eb2d45be8c490594fc7ba4a7b38dc8d8

Query parameters

        id = 14a30648f3d37d6429baf30d3975f076
   add_ids = f7d135c13b033407c35278250895a310,e7376754d40dc62b237edbe576ba9d74
delete_ids = c6d62e4c9b8d68c3f23b9e07095b0f61,96cc0393a34817294da77c3fcf91fe97,18e9c98160ea37743b43e88bef91e1e2,eb2d45be8c490594fc7ba4a7b38dc8d8

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "added": 2,
    "deleted": 4
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/subusers/projects/grant?id=14a30648f3d37d6429baf30d3975f076&add_ids=f7d135c13b033407c35278250895a310,e7376754d40dc62b237edbe576ba9d74&delete_ids=c6d62e4c9b8d68c3f23b9e07095b0f61,96cc0393a34817294da77c3fcf91fe97,18e9c98160ea37743b43e88bef91e1e2,eb2d45be8c490594fc7ba4a7b38dc8d8&format=xml

Query parameters

        id = 14a30648f3d37d6429baf30d3975f076
   add_ids = f7d135c13b033407c35278250895a310,e7376754d40dc62b237edbe576ba9d74
delete_ids = c6d62e4c9b8d68c3f23b9e07095b0f61,96cc0393a34817294da77c3fcf91fe97,18e9c98160ea37743b43e88bef91e1e2,eb2d45be8c490594fc7ba4a7b38dc8d8
    format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <added>2</added>  
    <deleted>4</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/subusers/projects/grant?id=14a30648f3d37d6429baf30d3975f076&add_ids=f7d135c13b033407c35278250895a310,e7376754d40dc62b237edbe576ba9d74&delete_ids=c6d62e4c9b8d68c3f23b9e07095b0f61,96cc0393a34817294da77c3fcf91fe97,18e9c98160ea37743b43e88bef91e1e2,eb2d45be8c490594fc7ba4a7b38dc8d8&format=txt

Query parameters

        id = 14a30648f3d37d6429baf30d3975f076
   add_ids = f7d135c13b033407c35278250895a310,e7376754d40dc62b237edbe576ba9d74
delete_ids = c6d62e4c9b8d68c3f23b9e07095b0f61,96cc0393a34817294da77c3fcf91fe97,18e9c98160ea37743b43e88bef91e1e2,eb2d45be8c490594fc7ba4a7b38dc8d8
    format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_added=2
result_deleted=4

Example 4 (plain)

Request

https://joturl.com/a/i1/subusers/projects/grant?id=14a30648f3d37d6429baf30d3975f076&add_ids=f7d135c13b033407c35278250895a310,e7376754d40dc62b237edbe576ba9d74&delete_ids=c6d62e4c9b8d68c3f23b9e07095b0f61,96cc0393a34817294da77c3fcf91fe97,18e9c98160ea37743b43e88bef91e1e2,eb2d45be8c490594fc7ba4a7b38dc8d8&format=plain

Query parameters

        id = 14a30648f3d37d6429baf30d3975f076
   add_ids = f7d135c13b033407c35278250895a310,e7376754d40dc62b237edbe576ba9d74
delete_ids = c6d62e4c9b8d68c3f23b9e07095b0f61,96cc0393a34817294da77c3fcf91fe97,18e9c98160ea37743b43e88bef91e1e2,eb2d45be8c490594fc7ba4a7b38dc8d8
    format = plain

Response

2
4
Required parameters
parameterdescription
idIDID of the team member
Optional parameters
parameterdescription
add_idsARRAY_OF_IDScomma separated list of project IDs to grant access to the team member
delete_idsARRAY_OF_IDScomma-separated list of project IDs to deny access to the team member
Return values
parameterdescription
addednumber of project IDs that the team member has been granted access to
deletednumber of project IDs that the team member was denied access to

/subusers/roles_groups

/subusers/roles_groups/list

access: [READ]

This method returns a list of roles or groups previously used.

Example 1 (json)

Request

https://joturl.com/a/i1/subusers/roles_groups/list?type=role&search=test

Query parameters

  type = role
search = test

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": [
    "test",
    "Tester",
    "main tester"
  ]
}

Example 2 (xml)

Request

https://joturl.com/a/i1/subusers/roles_groups/list?type=role&search=test&format=xml

Query parameters

  type = role
search = test
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <i0>test</i0>  
    <i1>Tester</i1>  
    <i2>main tester</i2>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/subusers/roles_groups/list?type=role&search=test&format=txt

Query parameters

  type = role
search = test
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_0=test
result_1=Tester
result_2=main tester

Example 4 (plain)

Request

https://joturl.com/a/i1/subusers/roles_groups/list?type=role&search=test&format=plain

Query parameters

  type = role
search = test
format = plain

Response

test
Tester
main tester
Required parameters
parameterdescription
typeSTRINGtype to list, available types: [role, group]
Optional parameters
parameterdescription
lengthINTEGERextracts this number of roles &amp; groups (maxmimum allowed: 100)
searchSTRINGfilters roles &amp; groups to be extracted by searching them
startINTEGERstarts to extract roles &amp; groups from this position
Return values
parameterdescription
[ARRAY]array containing requested information.

/urls

/urls/balancers

/urls/balancers/clone

access: [WRITE]

Clone the balancer configuration from a tracking link to another.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/balancers/clone?from_url_id=460f84d3161cf5042b75c2d75dcdc134&to_url_id=c9243266ed84f33b128e18d087d4b63e

Query parameters

from_url_id = 460f84d3161cf5042b75c2d75dcdc134
  to_url_id = c9243266ed84f33b128e18d087d4b63e

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "cloned": 0
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/balancers/clone?from_url_id=460f84d3161cf5042b75c2d75dcdc134&to_url_id=c9243266ed84f33b128e18d087d4b63e&format=xml

Query parameters

from_url_id = 460f84d3161cf5042b75c2d75dcdc134
  to_url_id = c9243266ed84f33b128e18d087d4b63e
     format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <cloned>0</cloned>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/balancers/clone?from_url_id=460f84d3161cf5042b75c2d75dcdc134&to_url_id=c9243266ed84f33b128e18d087d4b63e&format=txt

Query parameters

from_url_id = 460f84d3161cf5042b75c2d75dcdc134
  to_url_id = c9243266ed84f33b128e18d087d4b63e
     format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_cloned=0

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/balancers/clone?from_url_id=460f84d3161cf5042b75c2d75dcdc134&to_url_id=c9243266ed84f33b128e18d087d4b63e&format=plain

Query parameters

from_url_id = 460f84d3161cf5042b75c2d75dcdc134
  to_url_id = c9243266ed84f33b128e18d087d4b63e
     format = plain

Response

0
Required parameters
parameterdescription
from_url_idIDID of the tracking link you want to copy the balancer configuration from
to_url_idIDID of the tracking link you want to copy the balancer configuration to
Return values
parameterdescription
cloned1 on success, 0 otherwise

/urls/balancers/delete

access: [WRITE]

Delete the smart balancer linked to a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/balancers/delete?id=2512085abc90087e7feb21268e60dd8b

Query parameters

id = 2512085abc90087e7feb21268e60dd8b

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/balancers/delete?id=2512085abc90087e7feb21268e60dd8b&format=xml

Query parameters

    id = 2512085abc90087e7feb21268e60dd8b
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/balancers/delete?id=2512085abc90087e7feb21268e60dd8b&format=txt

Query parameters

    id = 2512085abc90087e7feb21268e60dd8b
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/balancers/delete?id=2512085abc90087e7feb21268e60dd8b&format=plain

Query parameters

    id = 2512085abc90087e7feb21268e60dd8b
format = plain

Response

1
Required parameters
parameterdescription
idIDID of the tracking link from which to remove the balancer
Return values
parameterdescription
deleted1 on success, 0 otherwise

/urls/balancers/edit

access: [WRITE]

Set the smart balancer for a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/balancers/edit?id=f85ce2fbd24c085d93d3cc4f388a899a&type=WEIGHTED&urls=%5B%22https%3A%5C%2F%5C%2Fwww.joturl.com%5C%2Fpricing%5C%2F%22,%22https%3A%5C%2F%5C%2Fwww.joturl.com%5C%2F%22%5D&weights=%5B22.22,77.78%5D

Query parameters

     id = f85ce2fbd24c085d93d3cc4f388a899a
   type = WEIGHTED
   urls = ["https:\/\/www.joturl.com\/pricing\/","https:\/\/www.joturl.com\/"]
weights = [22.22,77.78]

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "enabled": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/balancers/edit?id=f85ce2fbd24c085d93d3cc4f388a899a&type=WEIGHTED&urls=%5B%22https%3A%5C%2F%5C%2Fwww.joturl.com%5C%2Fpricing%5C%2F%22,%22https%3A%5C%2F%5C%2Fwww.joturl.com%5C%2F%22%5D&weights=%5B22.22,77.78%5D&format=xml

Query parameters

     id = f85ce2fbd24c085d93d3cc4f388a899a
   type = WEIGHTED
   urls = ["https:\/\/www.joturl.com\/pricing\/","https:\/\/www.joturl.com\/"]
weights = [22.22,77.78]
 format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <enabled>1</enabled>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/balancers/edit?id=f85ce2fbd24c085d93d3cc4f388a899a&type=WEIGHTED&urls=%5B%22https%3A%5C%2F%5C%2Fwww.joturl.com%5C%2Fpricing%5C%2F%22,%22https%3A%5C%2F%5C%2Fwww.joturl.com%5C%2F%22%5D&weights=%5B22.22,77.78%5D&format=txt

Query parameters

     id = f85ce2fbd24c085d93d3cc4f388a899a
   type = WEIGHTED
   urls = ["https:\/\/www.joturl.com\/pricing\/","https:\/\/www.joturl.com\/"]
weights = [22.22,77.78]
 format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_enabled=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/balancers/edit?id=f85ce2fbd24c085d93d3cc4f388a899a&type=WEIGHTED&urls=%5B%22https%3A%5C%2F%5C%2Fwww.joturl.com%5C%2Fpricing%5C%2F%22,%22https%3A%5C%2F%5C%2Fwww.joturl.com%5C%2F%22%5D&weights=%5B22.22,77.78%5D&format=plain

Query parameters

     id = f85ce2fbd24c085d93d3cc4f388a899a
   type = WEIGHTED
   urls = ["https:\/\/www.joturl.com\/pricing\/","https:\/\/www.joturl.com\/"]
weights = [22.22,77.78]
 format = plain

Response

1
Required parameters
parameterdescription
idIDID of the tracking link on which to enable the balancer
typeSTRINGbalancer type, available types: SEQUENTIAL, WEIGHTED, WEIGHTED_FIXED, RANDOM, RANDOM_FIXED, SWITCHING, SPLIT_TEST
urlsJSONJSON array of destination URLs to be used with the balancer, a maximum of 5 destination URLs can be used when type = SPLIT_TEST, otherwise a maximum of 100 destination URLs is allowed
Optional parameters
parameterdescription
conversionsARRAY_OF_IDSconversion codes to be used when type = SPLIT_TEST
weightsJSONJSON array of floats between 0.0 and 100.0, the balancer will use these floats to randomly select destination URLs, this parameter is mandatory for type = WEIGHTED and type = WEIGHTED_FIXED, it must contain the same number of items in urls
Return values
parameterdescription
enabled1 on success, 0 otherwise

/urls/balancers/info

access: [READ]

Get the smart balancer linked to a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/balancers/info?id=f25196356075a61a6ca6e1f8d17997f3

Query parameters

id = f25196356075a61a6ca6e1f8d17997f3

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "f25196356075a61a6ca6e1f8d17997f3",
    "type": "WEIGHTED",
    "info": [
      {
        "url": "https:\/\/www.joturl.com\/pricing\/",
        "weight": "22.22"
      },
      {
        "url": "https:\/\/www.joturl.com\/",
        "weight": "77.78"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/balancers/info?id=f25196356075a61a6ca6e1f8d17997f3&format=xml

Query parameters

    id = f25196356075a61a6ca6e1f8d17997f3
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>f25196356075a61a6ca6e1f8d17997f3</id>  
    <type>WEIGHTED</type>  
    <info>
      <i0>
        <url>https://www.joturl.com/pricing/</url>  
        <weight>22.22</weight>  
      </i0>  
      <i1>
        <url>https://www.joturl.com/</url>  
        <weight>77.78</weight>  
      </i1>  
    </info>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/balancers/info?id=f25196356075a61a6ca6e1f8d17997f3&format=txt

Query parameters

    id = f25196356075a61a6ca6e1f8d17997f3
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=f25196356075a61a6ca6e1f8d17997f3
result_type=WEIGHTED
result_info_0_url=https://www.joturl.com/pricing/
result_info_0_weight=22.22
result_info_1_url=https://www.joturl.com/
result_info_1_weight=77.78

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/balancers/info?id=f25196356075a61a6ca6e1f8d17997f3&format=plain

Query parameters

    id = f25196356075a61a6ca6e1f8d17997f3
format = plain

Response

f25196356075a61a6ca6e1f8d17997f3
WEIGHTED
https://www.joturl.com/pricing/
22.22
https://www.joturl.com/
77.78
Required parameters
parameterdescription
idIDID of the tracking link whose balancer configuration is desired
Return values
parameterdescription
idecho back of parameter id
infoarray of couples (url, weight)
typebalancer type, see i1/urls/balancers/edit for details

/urls/balancers/property

access: [READ]

This method returns smart balancer types that are available to the logged users.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/balancers/property

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "types": {
      "SEQUENTIAL": {
        "is_split": 0
      },
      "WEIGHTED": {
        "is_split": 0
      },
      "WEIGHTED_FIXED": {
        "is_split": 0
      },
      "RANDOM": {
        "is_split": 0
      },
      "RANDOM_FIXED": {
        "is_split": 0
      },
      "SWITCHING": {
        "is_split": 0
      },
      "SPLIT_TEST": {
        "is_split": 1
      }
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/balancers/property?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <types>
      <SEQUENTIAL>
        <is_split>0</is_split>  
      </SEQUENTIAL>  
      <WEIGHTED>
        <is_split>0</is_split>  
      </WEIGHTED>  
      <WEIGHTED_FIXED>
        <is_split>0</is_split>  
      </WEIGHTED_FIXED>  
      <RANDOM>
        <is_split>0</is_split>  
      </RANDOM>  
      <RANDOM_FIXED>
        <is_split>0</is_split>  
      </RANDOM_FIXED>  
      <SWITCHING>
        <is_split>0</is_split>  
      </SWITCHING>  
      <SPLIT_TEST>
        <is_split>1</is_split>  
      </SPLIT_TEST>  
    </types>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/balancers/property?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_types_SEQUENTIAL_is_split=0
result_types_WEIGHTED_is_split=0
result_types_WEIGHTED_FIXED_is_split=0
result_types_RANDOM_is_split=0
result_types_RANDOM_FIXED_is_split=0
result_types_SWITCHING_is_split=0
result_types_SPLIT_TEST_is_split=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/balancers/property?format=plain

Query parameters

format = plain

Response

0
0
0
0
0
0
1
Return values
parameterdescription
typesarray of smart balancer types

/urls/cloaking

/urls/cloaking/clone

access: [WRITE]

Clone a cloaking configuration from a tracking link to another.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/cloaking/clone?from_url_id=ca1aa0d1b8c78f10e62cc8f61ccf3754&to_url_id=bd22200dcdb8488e4243bfc56301300c

Query parameters

from_url_id = ca1aa0d1b8c78f10e62cc8f61ccf3754
  to_url_id = bd22200dcdb8488e4243bfc56301300c

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "cloned": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/cloaking/clone?from_url_id=ca1aa0d1b8c78f10e62cc8f61ccf3754&to_url_id=bd22200dcdb8488e4243bfc56301300c&format=xml

Query parameters

from_url_id = ca1aa0d1b8c78f10e62cc8f61ccf3754
  to_url_id = bd22200dcdb8488e4243bfc56301300c
     format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <cloned>1</cloned>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/cloaking/clone?from_url_id=ca1aa0d1b8c78f10e62cc8f61ccf3754&to_url_id=bd22200dcdb8488e4243bfc56301300c&format=txt

Query parameters

from_url_id = ca1aa0d1b8c78f10e62cc8f61ccf3754
  to_url_id = bd22200dcdb8488e4243bfc56301300c
     format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_cloned=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/cloaking/clone?from_url_id=ca1aa0d1b8c78f10e62cc8f61ccf3754&to_url_id=bd22200dcdb8488e4243bfc56301300c&format=plain

Query parameters

from_url_id = ca1aa0d1b8c78f10e62cc8f61ccf3754
  to_url_id = bd22200dcdb8488e4243bfc56301300c
     format = plain

Response

1
Required parameters
parameterdescription
from_url_idIDID of the tracking link you want to copy cloaking configuration from
to_url_idIDID of the tracking link you want to copy cloaking configuration to
Return values
parameterdescription
cloned1 on success, 0 otherwise

/urls/cloaking/delete

access: [WRITE]

Delete the cloaking configuration of a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/cloaking/delete?id=184e652a0953726fe3ccbef1b70c2ed1

Query parameters

id = 184e652a0953726fe3ccbef1b70c2ed1

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/cloaking/delete?id=184e652a0953726fe3ccbef1b70c2ed1&format=xml

Query parameters

    id = 184e652a0953726fe3ccbef1b70c2ed1
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/cloaking/delete?id=184e652a0953726fe3ccbef1b70c2ed1&format=txt

Query parameters

    id = 184e652a0953726fe3ccbef1b70c2ed1
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/cloaking/delete?id=184e652a0953726fe3ccbef1b70c2ed1&format=plain

Query parameters

    id = 184e652a0953726fe3ccbef1b70c2ed1
format = plain

Response

1
Required parameters
parameterdescription
idIDID of the tracking link from which to remove a cloaking configuration
Return values
parameterdescription
deleted1 on success, 0 otherwise

/urls/cloaking/edit

access: [WRITE]

Given the ID of a tracking link, sets a cloaking configuration.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/cloaking/edit?id=232f7b116f0c8c5ab5772a478b167338&settings=%7B%22block_url%22%3A%22https%3A%5C%2F%5C%2Fwww.google.com%5C%2F%22,%22corporate_ips_and_bots%22%3A%7B%22block%22%3Atrue%7D,%22desktop_devices%22%3A%7B%22block%22%3Atrue%7D,%22mobile_devices%22%3A%7B%22block%22%3Afalse%7D,%22countries%22%3A%7B%22block%22%3Atrue,%22mode%22%3A%22deny_all_except%22,%22list%22%3A%5B%22IT%22,%22US%22,%22FR%22%5D%7D%7D

Query parameters

      id = 232f7b116f0c8c5ab5772a478b167338
settings = {"block_url":"https:\/\/www.google.com\/","corporate_ips_and_bots":{"block":true},"desktop_devices":{"block":true},"mobile_devices":{"block":false},"countries":{"block":true,"mode":"deny_all_except","list":["IT","US","FR"]}}

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "enabled": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/cloaking/edit?id=232f7b116f0c8c5ab5772a478b167338&settings=%7B%22block_url%22%3A%22https%3A%5C%2F%5C%2Fwww.google.com%5C%2F%22,%22corporate_ips_and_bots%22%3A%7B%22block%22%3Atrue%7D,%22desktop_devices%22%3A%7B%22block%22%3Atrue%7D,%22mobile_devices%22%3A%7B%22block%22%3Afalse%7D,%22countries%22%3A%7B%22block%22%3Atrue,%22mode%22%3A%22deny_all_except%22,%22list%22%3A%5B%22IT%22,%22US%22,%22FR%22%5D%7D%7D&format=xml

Query parameters

      id = 232f7b116f0c8c5ab5772a478b167338
settings = {"block_url":"https:\/\/www.google.com\/","corporate_ips_and_bots":{"block":true},"desktop_devices":{"block":true},"mobile_devices":{"block":false},"countries":{"block":true,"mode":"deny_all_except","list":["IT","US","FR"]}}
  format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <enabled>1</enabled>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/cloaking/edit?id=232f7b116f0c8c5ab5772a478b167338&settings=%7B%22block_url%22%3A%22https%3A%5C%2F%5C%2Fwww.google.com%5C%2F%22,%22corporate_ips_and_bots%22%3A%7B%22block%22%3Atrue%7D,%22desktop_devices%22%3A%7B%22block%22%3Atrue%7D,%22mobile_devices%22%3A%7B%22block%22%3Afalse%7D,%22countries%22%3A%7B%22block%22%3Atrue,%22mode%22%3A%22deny_all_except%22,%22list%22%3A%5B%22IT%22,%22US%22,%22FR%22%5D%7D%7D&format=txt

Query parameters

      id = 232f7b116f0c8c5ab5772a478b167338
settings = {"block_url":"https:\/\/www.google.com\/","corporate_ips_and_bots":{"block":true},"desktop_devices":{"block":true},"mobile_devices":{"block":false},"countries":{"block":true,"mode":"deny_all_except","list":["IT","US","FR"]}}
  format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_enabled=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/cloaking/edit?id=232f7b116f0c8c5ab5772a478b167338&settings=%7B%22block_url%22%3A%22https%3A%5C%2F%5C%2Fwww.google.com%5C%2F%22,%22corporate_ips_and_bots%22%3A%7B%22block%22%3Atrue%7D,%22desktop_devices%22%3A%7B%22block%22%3Atrue%7D,%22mobile_devices%22%3A%7B%22block%22%3Afalse%7D,%22countries%22%3A%7B%22block%22%3Atrue,%22mode%22%3A%22deny_all_except%22,%22list%22%3A%5B%22IT%22,%22US%22,%22FR%22%5D%7D%7D&format=plain

Query parameters

      id = 232f7b116f0c8c5ab5772a478b167338
settings = {"block_url":"https:\/\/www.google.com\/","corporate_ips_and_bots":{"block":true},"desktop_devices":{"block":true},"mobile_devices":{"block":false},"countries":{"block":true,"mode":"deny_all_except","list":["IT","US","FR"]}}
  format = plain

Response

1

Example 5 (json)

Request

https://joturl.com/a/i1/urls/cloaking/edit?id=8d40d1da48f2bbbda4199df83fc73714&settings=%7B%22block_url%22%3A%22https%3A%5C%2F%5C%2Fwww.amazon.com%5C%2F%22,%22corporate_ips_and_bots%22%3A%7B%22block%22%3Afalse%7D,%22desktop_devices%22%3A%7B%22block%22%3Afalse%7D,%22mobile_devices%22%3A%7B%22block%22%3Atrue,%22redirect_to%22%3A%22https%3A%5C%2F%5C%2Fwww.google.com%5C%2F%22%7D,%22countries%22%3A%7B%22block%22%3Atrue,%22mode%22%3A%22allow_all_except%22,%22list%22%3A%5B%22NL%22,%22ES%22%5D%7D%7D

Query parameters

      id = 8d40d1da48f2bbbda4199df83fc73714
settings = {"block_url":"https:\/\/www.amazon.com\/","corporate_ips_and_bots":{"block":false},"desktop_devices":{"block":false},"mobile_devices":{"block":true,"redirect_to":"https:\/\/www.google.com\/"},"countries":{"block":true,"mode":"allow_all_except","list":["NL","ES"]}}

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "enabled": 1
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/urls/cloaking/edit?id=8d40d1da48f2bbbda4199df83fc73714&settings=%7B%22block_url%22%3A%22https%3A%5C%2F%5C%2Fwww.amazon.com%5C%2F%22,%22corporate_ips_and_bots%22%3A%7B%22block%22%3Afalse%7D,%22desktop_devices%22%3A%7B%22block%22%3Afalse%7D,%22mobile_devices%22%3A%7B%22block%22%3Atrue,%22redirect_to%22%3A%22https%3A%5C%2F%5C%2Fwww.google.com%5C%2F%22%7D,%22countries%22%3A%7B%22block%22%3Atrue,%22mode%22%3A%22allow_all_except%22,%22list%22%3A%5B%22NL%22,%22ES%22%5D%7D%7D&format=xml

Query parameters

      id = 8d40d1da48f2bbbda4199df83fc73714
settings = {"block_url":"https:\/\/www.amazon.com\/","corporate_ips_and_bots":{"block":false},"desktop_devices":{"block":false},"mobile_devices":{"block":true,"redirect_to":"https:\/\/www.google.com\/"},"countries":{"block":true,"mode":"allow_all_except","list":["NL","ES"]}}
  format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <enabled>1</enabled>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/urls/cloaking/edit?id=8d40d1da48f2bbbda4199df83fc73714&settings=%7B%22block_url%22%3A%22https%3A%5C%2F%5C%2Fwww.amazon.com%5C%2F%22,%22corporate_ips_and_bots%22%3A%7B%22block%22%3Afalse%7D,%22desktop_devices%22%3A%7B%22block%22%3Afalse%7D,%22mobile_devices%22%3A%7B%22block%22%3Atrue,%22redirect_to%22%3A%22https%3A%5C%2F%5C%2Fwww.google.com%5C%2F%22%7D,%22countries%22%3A%7B%22block%22%3Atrue,%22mode%22%3A%22allow_all_except%22,%22list%22%3A%5B%22NL%22,%22ES%22%5D%7D%7D&format=txt

Query parameters

      id = 8d40d1da48f2bbbda4199df83fc73714
settings = {"block_url":"https:\/\/www.amazon.com\/","corporate_ips_and_bots":{"block":false},"desktop_devices":{"block":false},"mobile_devices":{"block":true,"redirect_to":"https:\/\/www.google.com\/"},"countries":{"block":true,"mode":"allow_all_except","list":["NL","ES"]}}
  format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_enabled=1

Example 8 (plain)

Request

https://joturl.com/a/i1/urls/cloaking/edit?id=8d40d1da48f2bbbda4199df83fc73714&settings=%7B%22block_url%22%3A%22https%3A%5C%2F%5C%2Fwww.amazon.com%5C%2F%22,%22corporate_ips_and_bots%22%3A%7B%22block%22%3Afalse%7D,%22desktop_devices%22%3A%7B%22block%22%3Afalse%7D,%22mobile_devices%22%3A%7B%22block%22%3Atrue,%22redirect_to%22%3A%22https%3A%5C%2F%5C%2Fwww.google.com%5C%2F%22%7D,%22countries%22%3A%7B%22block%22%3Atrue,%22mode%22%3A%22allow_all_except%22,%22list%22%3A%5B%22NL%22,%22ES%22%5D%7D%7D&format=plain

Query parameters

      id = 8d40d1da48f2bbbda4199df83fc73714
settings = {"block_url":"https:\/\/www.amazon.com\/","corporate_ips_and_bots":{"block":false},"desktop_devices":{"block":false},"mobile_devices":{"block":true,"redirect_to":"https:\/\/www.google.com\/"},"countries":{"block":true,"mode":"allow_all_except","list":["NL","ES"]}}
  format = plain

Response

1
Required parameters
parameterdescription
idIDID of the tracking link
settingsJSONstringified JSON of the cloaking configuration, see i1/urls/cloaking/info for details
Return values
parameterdescription
enabled1 if the cloaking option has been successfully enabled, 0 otherwise

/urls/cloaking/info

access: [READ]

Returns information on the cloaking configuration.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/cloaking/info?id=a2fe718df5e11f05a60166e5b288aa81

Query parameters

id = a2fe718df5e11f05a60166e5b288aa81

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "a2fe718df5e11f05a60166e5b288aa81",
    "settings": "{\"block_url\":\"https:\\\/\\\/www.google.com\\\/\",\"corporate_ips_and_bots\":{\"block\":true},\"desktop_devices\":{\"block\":true},\"mobile_devices\":{\"block\":false},\"countries\":{\"block\":true,\"mode\":\"deny_all_except\",\"list\":[\"IT\",\"US\",\"FR\"]}}"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/cloaking/info?id=a2fe718df5e11f05a60166e5b288aa81&format=xml

Query parameters

    id = a2fe718df5e11f05a60166e5b288aa81
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>a2fe718df5e11f05a60166e5b288aa81</id>  
    <settings>{"block_url":"https:\/\/www.google.com\/","corporate_ips_and_bots":{"block":true},"desktop_devices":{"block":true},"mobile_devices":{"block":false},"countries":{"block":true,"mode":"deny_all_except","list":["IT","US","FR"]}}</settings>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/cloaking/info?id=a2fe718df5e11f05a60166e5b288aa81&format=txt

Query parameters

    id = a2fe718df5e11f05a60166e5b288aa81
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=a2fe718df5e11f05a60166e5b288aa81
result_settings={"block_url":"https:\/\/www.google.com\/","corporate_ips_and_bots":{"block":true},"desktop_devices":{"block":true},"mobile_devices":{"block":false},"countries":{"block":true,"mode":"deny_all_except","list":["IT","US","FR"]}}

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/cloaking/info?id=a2fe718df5e11f05a60166e5b288aa81&format=plain

Query parameters

    id = a2fe718df5e11f05a60166e5b288aa81
format = plain

Response

a2fe718df5e11f05a60166e5b288aa81
{"block_url":"https:\/\/www.google.com\/","corporate_ips_and_bots":{"block":true},"desktop_devices":{"block":true},"mobile_devices":{"block":false},"countries":{"block":true,"mode":"deny_all_except","list":["IT","US","FR"]}}

Example 5 (json)

Request

https://joturl.com/a/i1/urls/cloaking/info?id=d2d1abad89405386fee60ab1d45b369d

Query parameters

id = d2d1abad89405386fee60ab1d45b369d

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "d2d1abad89405386fee60ab1d45b369d",
    "settings": "{\"block_url\":\"https:\\\/\\\/www.google.com\\\/\",\"corporate_ips_and_bots\":{\"block\":true},\"desktop_devices\":{\"block\":false},\"mobile_devices\":{\"block\":true,\"redirect_to\":\"https:\\\/\\\/www.amazon.com\\\/\"},\"countries\":{\"block\":true,\"mode\":\"allow_all_except\",\"list\":[\"NL\",\"ES\"]}}"
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/urls/cloaking/info?id=d2d1abad89405386fee60ab1d45b369d&format=xml

Query parameters

    id = d2d1abad89405386fee60ab1d45b369d
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>d2d1abad89405386fee60ab1d45b369d</id>  
    <settings>{"block_url":"https:\/\/www.google.com\/","corporate_ips_and_bots":{"block":true},"desktop_devices":{"block":false},"mobile_devices":{"block":true,"redirect_to":"https:\/\/www.amazon.com\/"},"countries":{"block":true,"mode":"allow_all_except","list":["NL","ES"]}}</settings>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/urls/cloaking/info?id=d2d1abad89405386fee60ab1d45b369d&format=txt

Query parameters

    id = d2d1abad89405386fee60ab1d45b369d
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=d2d1abad89405386fee60ab1d45b369d
result_settings={"block_url":"https:\/\/www.google.com\/","corporate_ips_and_bots":{"block":true},"desktop_devices":{"block":false},"mobile_devices":{"block":true,"redirect_to":"https:\/\/www.amazon.com\/"},"countries":{"block":true,"mode":"allow_all_except","list":["NL","ES"]}}

Example 8 (plain)

Request

https://joturl.com/a/i1/urls/cloaking/info?id=d2d1abad89405386fee60ab1d45b369d&format=plain

Query parameters

    id = d2d1abad89405386fee60ab1d45b369d
format = plain

Response

d2d1abad89405386fee60ab1d45b369d
{"block_url":"https:\/\/www.google.com\/","corporate_ips_and_bots":{"block":true},"desktop_devices":{"block":false},"mobile_devices":{"block":true,"redirect_to":"https:\/\/www.amazon.com\/"},"countries":{"block":true,"mode":"allow_all_except","list":["NL","ES"]}}
Required parameters
parameterdescription
idIDID of the tracking link
Return values
parameterdescription
data[OPTIONAL] stringified JSON of the cloaking configuration, this parameter is returned only if a cloaking configuration is available for the tracking link

/urls/clone

access: [WRITE]

This method clones options of a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/clone?fields=id,short_url&src_id=620990bccab77f8b053f495e33f8f859&alias=5d8aa971&long_url=https%3A%2F%2Fwww.joturl.com%2F&domain_id=746cfea3e7452f480a8e7df9e9453a97

Query parameters

   fields = id,short_url
   src_id = 620990bccab77f8b053f495e33f8f859
    alias = 5d8aa971
 long_url = https://www.joturl.com/
domain_id = 746cfea3e7452f480a8e7df9e9453a97

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "cloned": 1,
    "added": 0,
    "removed": 0,
    "failed": [],
    "id": "6aa808f8cf7752b54caf05fc71a51732",
    "short_url": "http:\/\/jo.my\/5d8aa971"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/clone?fields=id,short_url&src_id=620990bccab77f8b053f495e33f8f859&alias=5d8aa971&long_url=https%3A%2F%2Fwww.joturl.com%2F&domain_id=746cfea3e7452f480a8e7df9e9453a97&format=xml

Query parameters

   fields = id,short_url
   src_id = 620990bccab77f8b053f495e33f8f859
    alias = 5d8aa971
 long_url = https://www.joturl.com/
domain_id = 746cfea3e7452f480a8e7df9e9453a97
   format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <cloned>1</cloned>  
    <added>0</added>  
    <removed>0</removed>  
    <failed>

    </failed>  
    <id>6aa808f8cf7752b54caf05fc71a51732</id>  
    <short_url>http://jo.my/5d8aa971</short_url>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/clone?fields=id,short_url&src_id=620990bccab77f8b053f495e33f8f859&alias=5d8aa971&long_url=https%3A%2F%2Fwww.joturl.com%2F&domain_id=746cfea3e7452f480a8e7df9e9453a97&format=txt

Query parameters

   fields = id,short_url
   src_id = 620990bccab77f8b053f495e33f8f859
    alias = 5d8aa971
 long_url = https://www.joturl.com/
domain_id = 746cfea3e7452f480a8e7df9e9453a97
   format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_cloned=1
result_added=0
result_removed=0
result_failed=
result_id=6aa808f8cf7752b54caf05fc71a51732
result_short_url=http://jo.my/5d8aa971

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/clone?fields=id,short_url&src_id=620990bccab77f8b053f495e33f8f859&alias=5d8aa971&long_url=https%3A%2F%2Fwww.joturl.com%2F&domain_id=746cfea3e7452f480a8e7df9e9453a97&format=plain

Query parameters

   fields = id,short_url
   src_id = 620990bccab77f8b053f495e33f8f859
    alias = 5d8aa971
 long_url = https://www.joturl.com/
domain_id = 746cfea3e7452f480a8e7df9e9453a97
   format = plain

Response

http://jo.my/5d8aa971
Required parameters
parameterdescription
src_idIDID of the tracking link to be cloned
Optional parameters
parameterdescriptionmax length
aliasSTRINGalias for the cloned tracking link, see i1/urls/shorten for details510
domain_idIDID of the domain for the cloned tracking link, if not specified the domain of the source tracking link will be used
dst_idIDID of the tracking link on which to clone the options
fieldsARRAYcomma separated list of fields to return after cloning is complete, see method i1/urls/list for reference.
long_urlSTRINGdestination URL for the cloned tracking link, not available for tracking pixels, if empty, the destination URL of the source tracking link will be used4000
notesSTRINGnotes for the cloned tracking link255
project_idIDID of the project where the cloned tracking link will be put in, if not specified the project of the source tracking link will be used
tagsARRAYcomma-separated list of tags for the cloned tracking link
Return values
parameterdescription
[FIELDS][OPTIONAL] fields containing information on cloned tracking links, the information returned depends on the fields parameter, no field is returned if the fields parameter is empty. See i1/urls/list for details on fields
addedtotal number of options added or changed in the destination tracking link
clonedtotal number of cloned options (removed + added/changed), this parameter can be 0 if the tracking link you cloned has no options, or if an error occurred, in the latter case the parameter failed is not empty
failedlist of options that could not be added, modified or deleted from the destination tracking link due to an error, this parameter can be empty when the cloned tracking link has no options or when no error occurred during cloning, see i1/urls/options/list for details on returned values
removedtotal number of options removed in the destination tracking link

/urls/conversions

/urls/conversions/add

access: [WRITE]

Add conversion codes to a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/conversions/add?url_id=064aa5ddeb4bc60abf2304dd85cc1337&ids=3a82b75622aba6bb6f5c2f763994f7bc,f53be3c3acf6fa9bff74e8ec99eb5ceb

Query parameters

url_id = 064aa5ddeb4bc60abf2304dd85cc1337
   ids = 3a82b75622aba6bb6f5c2f763994f7bc,f53be3c3acf6fa9bff74e8ec99eb5ceb

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "added": 2
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/conversions/add?url_id=064aa5ddeb4bc60abf2304dd85cc1337&ids=3a82b75622aba6bb6f5c2f763994f7bc,f53be3c3acf6fa9bff74e8ec99eb5ceb&format=xml

Query parameters

url_id = 064aa5ddeb4bc60abf2304dd85cc1337
   ids = 3a82b75622aba6bb6f5c2f763994f7bc,f53be3c3acf6fa9bff74e8ec99eb5ceb
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <added>2</added>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/conversions/add?url_id=064aa5ddeb4bc60abf2304dd85cc1337&ids=3a82b75622aba6bb6f5c2f763994f7bc,f53be3c3acf6fa9bff74e8ec99eb5ceb&format=txt

Query parameters

url_id = 064aa5ddeb4bc60abf2304dd85cc1337
   ids = 3a82b75622aba6bb6f5c2f763994f7bc,f53be3c3acf6fa9bff74e8ec99eb5ceb
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_added=2

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/conversions/add?url_id=064aa5ddeb4bc60abf2304dd85cc1337&ids=3a82b75622aba6bb6f5c2f763994f7bc,f53be3c3acf6fa9bff74e8ec99eb5ceb&format=plain

Query parameters

url_id = 064aa5ddeb4bc60abf2304dd85cc1337
   ids = 3a82b75622aba6bb6f5c2f763994f7bc,f53be3c3acf6fa9bff74e8ec99eb5ceb
format = plain

Response

2
Required parameters
parameterdescription
idsARRAY_OF_IDScomma-separated list of conversion codes to add (maxmimum number of conversion codes: 5)
url_idIDID of the tracking link to which to add one or more conversion codes
Return values
parameterdescription
added0 on error, the number of added conversion codes otherwise

/urls/conversions/clone

access: [WRITE]

Clone the conversions configuration from a tracking link to another.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/conversions/clone?from_url_id=3dab308d652eedcb01c1ba770029d592&to_url_id=f1932b6dd35d10c99c9c237d7b02c9d2

Query parameters

from_url_id = 3dab308d652eedcb01c1ba770029d592
  to_url_id = f1932b6dd35d10c99c9c237d7b02c9d2

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "cloned": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/conversions/clone?from_url_id=3dab308d652eedcb01c1ba770029d592&to_url_id=f1932b6dd35d10c99c9c237d7b02c9d2&format=xml

Query parameters

from_url_id = 3dab308d652eedcb01c1ba770029d592
  to_url_id = f1932b6dd35d10c99c9c237d7b02c9d2
     format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <cloned>1</cloned>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/conversions/clone?from_url_id=3dab308d652eedcb01c1ba770029d592&to_url_id=f1932b6dd35d10c99c9c237d7b02c9d2&format=txt

Query parameters

from_url_id = 3dab308d652eedcb01c1ba770029d592
  to_url_id = f1932b6dd35d10c99c9c237d7b02c9d2
     format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_cloned=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/conversions/clone?from_url_id=3dab308d652eedcb01c1ba770029d592&to_url_id=f1932b6dd35d10c99c9c237d7b02c9d2&format=plain

Query parameters

from_url_id = 3dab308d652eedcb01c1ba770029d592
  to_url_id = f1932b6dd35d10c99c9c237d7b02c9d2
     format = plain

Response

1
Required parameters
parameterdescription
from_url_idIDID of the tracking link you want to copy the conversions configuration from
to_url_idIDID of the tracking link you want to copy the conversions configuration to
Return values
parameterdescription
cloned1 on success, 0 otherwise

/urls/conversions/count

access: [READ]

This method returns the number of conversion codes linked to a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/conversions/count?url_id=0818a30a13aa3303f5b5031fb0559ec3

Query parameters

url_id = 0818a30a13aa3303f5b5031fb0559ec3

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 4
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/conversions/count?url_id=0818a30a13aa3303f5b5031fb0559ec3&format=xml

Query parameters

url_id = 0818a30a13aa3303f5b5031fb0559ec3
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>4</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/conversions/count?url_id=0818a30a13aa3303f5b5031fb0559ec3&format=txt

Query parameters

url_id = 0818a30a13aa3303f5b5031fb0559ec3
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=4

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/conversions/count?url_id=0818a30a13aa3303f5b5031fb0559ec3&format=plain

Query parameters

url_id = 0818a30a13aa3303f5b5031fb0559ec3
format = plain

Response

4
Required parameters
parameterdescription
url_idIDID of the tracking link to check
Return values
parameterdescription
countthe number of linked conversion codes

/urls/conversions/delete

access: [WRITE]

Delete one or more conversion codes linked to a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/conversions/delete?url_id=a2e8cf506205156e5cd7b75732a1909b

Query parameters

url_id = a2e8cf506205156e5cd7b75732a1909b

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/conversions/delete?url_id=a2e8cf506205156e5cd7b75732a1909b&format=xml

Query parameters

url_id = a2e8cf506205156e5cd7b75732a1909b
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/conversions/delete?url_id=a2e8cf506205156e5cd7b75732a1909b&format=txt

Query parameters

url_id = a2e8cf506205156e5cd7b75732a1909b
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/conversions/delete?url_id=a2e8cf506205156e5cd7b75732a1909b&format=plain

Query parameters

url_id = a2e8cf506205156e5cd7b75732a1909b
format = plain

Response

1
Required parameters
parameterdescription
url_idIDID of the tracking link from which to remove one or more conversion codes
Optional parameters
parameterdescription
idsARRAY_OF_IDScomma-separated list of conversion codes to remove, if empty all conversion codes will be removed
Return values
parameterdescription
deleted1 on success, 0 otherwise

/urls/conversions/edit

access: [WRITE]

Edit the list of conversion codes linked to a tracking link (all previous conversion codes are removed).

Example 1 (json)

Request

https://joturl.com/a/i1/urls/conversions/edit?url_id=c9bdbc4ba0a01140cfb2e65ecb9f2bb8&ids=053cde324f4b1d897ad85b7067b63fd0,513406f73f593124fe593af31ddcd520,993e871478b9697adc53f6db092b9a0e,a868c7db422aae2fdb61af1a31c85628,96edbda3cd13861364be17dd24e4af75

Query parameters

url_id = c9bdbc4ba0a01140cfb2e65ecb9f2bb8
   ids = 053cde324f4b1d897ad85b7067b63fd0,513406f73f593124fe593af31ddcd520,993e871478b9697adc53f6db092b9a0e,a868c7db422aae2fdb61af1a31c85628,96edbda3cd13861364be17dd24e4af75

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "ids": "053cde324f4b1d897ad85b7067b63fd0,513406f73f593124fe593af31ddcd520,993e871478b9697adc53f6db092b9a0e,a868c7db422aae2fdb61af1a31c85628,96edbda3cd13861364be17dd24e4af75"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/conversions/edit?url_id=c9bdbc4ba0a01140cfb2e65ecb9f2bb8&ids=053cde324f4b1d897ad85b7067b63fd0,513406f73f593124fe593af31ddcd520,993e871478b9697adc53f6db092b9a0e,a868c7db422aae2fdb61af1a31c85628,96edbda3cd13861364be17dd24e4af75&format=xml

Query parameters

url_id = c9bdbc4ba0a01140cfb2e65ecb9f2bb8
   ids = 053cde324f4b1d897ad85b7067b63fd0,513406f73f593124fe593af31ddcd520,993e871478b9697adc53f6db092b9a0e,a868c7db422aae2fdb61af1a31c85628,96edbda3cd13861364be17dd24e4af75
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <ids>053cde324f4b1d897ad85b7067b63fd0,513406f73f593124fe593af31ddcd520,993e871478b9697adc53f6db092b9a0e,a868c7db422aae2fdb61af1a31c85628,96edbda3cd13861364be17dd24e4af75</ids>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/conversions/edit?url_id=c9bdbc4ba0a01140cfb2e65ecb9f2bb8&ids=053cde324f4b1d897ad85b7067b63fd0,513406f73f593124fe593af31ddcd520,993e871478b9697adc53f6db092b9a0e,a868c7db422aae2fdb61af1a31c85628,96edbda3cd13861364be17dd24e4af75&format=txt

Query parameters

url_id = c9bdbc4ba0a01140cfb2e65ecb9f2bb8
   ids = 053cde324f4b1d897ad85b7067b63fd0,513406f73f593124fe593af31ddcd520,993e871478b9697adc53f6db092b9a0e,a868c7db422aae2fdb61af1a31c85628,96edbda3cd13861364be17dd24e4af75
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_ids=053cde324f4b1d897ad85b7067b63fd0,513406f73f593124fe593af31ddcd520,993e871478b9697adc53f6db092b9a0e,a868c7db422aae2fdb61af1a31c85628,96edbda3cd13861364be17dd24e4af75

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/conversions/edit?url_id=c9bdbc4ba0a01140cfb2e65ecb9f2bb8&ids=053cde324f4b1d897ad85b7067b63fd0,513406f73f593124fe593af31ddcd520,993e871478b9697adc53f6db092b9a0e,a868c7db422aae2fdb61af1a31c85628,96edbda3cd13861364be17dd24e4af75&format=plain

Query parameters

url_id = c9bdbc4ba0a01140cfb2e65ecb9f2bb8
   ids = 053cde324f4b1d897ad85b7067b63fd0,513406f73f593124fe593af31ddcd520,993e871478b9697adc53f6db092b9a0e,a868c7db422aae2fdb61af1a31c85628,96edbda3cd13861364be17dd24e4af75
format = plain

Response

053cde324f4b1d897ad85b7067b63fd0,513406f73f593124fe593af31ddcd520,993e871478b9697adc53f6db092b9a0e,a868c7db422aae2fdb61af1a31c85628,96edbda3cd13861364be17dd24e4af75
Required parameters
parameterdescription
idsARRAY_OF_IDScomma-separated list of conversion codes to add (maxmimum number of conversion codes: 5)
url_idIDID of the tracking link to which to add one or more conversion codes
Return values
parameterdescription
idscomma-separated list of added conversion codes

/urls/conversions/list

access: [READ]

This method returns a list of conversion codes linked to a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/conversions/list?fields=count,name,id,enable_postback_url,actual_url_params&url_id=45b43433c2d7525fc81c5347a3ee4542

Query parameters

fields = count,name,id,enable_postback_url,actual_url_params
url_id = 45b43433c2d7525fc81c5347a3ee4542

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 3,
    "data": [
      {
        "name": "conversion name 1",
        "id": "70a4867091c204422e3881e6a4009136",
        "enable_postback_url": 0,
        "actual_url_params": ""
      },
      {
        "name": "conversion name 2 (with postback URL enabled)",
        "id": "54fd55935457184e30b8c521594b6764",
        "enable_postback_url": 1,
        "actual_url_params": "subid1={:CLICK_ID:}"
      },
      {
        "name": "conversion name 3",
        "id": "813b6aa20c396c08c2e36b384dc61419",
        "enable_postback_url": 0,
        "actual_url_params": ""
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/conversions/list?fields=count,name,id,enable_postback_url,actual_url_params&url_id=45b43433c2d7525fc81c5347a3ee4542&format=xml

Query parameters

fields = count,name,id,enable_postback_url,actual_url_params
url_id = 45b43433c2d7525fc81c5347a3ee4542
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>3</count>  
    <data>
      <i0>
        <name>conversion name 1</name>  
        <id>70a4867091c204422e3881e6a4009136</id>  
        <enable_postback_url>0</enable_postback_url>  
        <actual_url_params></actual_url_params>  
      </i0>  
      <i1>
        <name>conversion name 2 (with postback URL enabled)</name>  
        <id>54fd55935457184e30b8c521594b6764</id>  
        <enable_postback_url>1</enable_postback_url>  
        <actual_url_params>subid1={:CLICK_ID:}</actual_url_params>  
      </i1>  
      <i2>
        <name>conversion name 3</name>  
        <id>813b6aa20c396c08c2e36b384dc61419</id>  
        <enable_postback_url>0</enable_postback_url>  
        <actual_url_params></actual_url_params>  
      </i2>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/conversions/list?fields=count,name,id,enable_postback_url,actual_url_params&url_id=45b43433c2d7525fc81c5347a3ee4542&format=txt

Query parameters

fields = count,name,id,enable_postback_url,actual_url_params
url_id = 45b43433c2d7525fc81c5347a3ee4542
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=3
result_data_0_name=conversion name 1
result_data_0_id=70a4867091c204422e3881e6a4009136
result_data_0_enable_postback_url=0
result_data_0_actual_url_params=
result_data_1_name=conversion name 2 (with postback URL enabled)
result_data_1_id=54fd55935457184e30b8c521594b6764
result_data_1_enable_postback_url=1
result_data_1_actual_url_params=subid1={:CLICK_ID:}
result_data_2_name=conversion name 3
result_data_2_id=813b6aa20c396c08c2e36b384dc61419
result_data_2_enable_postback_url=0
result_data_2_actual_url_params=

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/conversions/list?fields=count,name,id,enable_postback_url,actual_url_params&url_id=45b43433c2d7525fc81c5347a3ee4542&format=plain

Query parameters

fields = count,name,id,enable_postback_url,actual_url_params
url_id = 45b43433c2d7525fc81c5347a3ee4542
format = plain

Response

3
conversion name 1
70a4867091c204422e3881e6a4009136
0

conversion name 2 (with postback URL enabled)
54fd55935457184e30b8c521594b6764
1
subid1={:CLICK_ID:}
conversion name 3
813b6aa20c396c08c2e36b384dc61419
0

Required parameters
parameterdescription
fieldsARRAYcomma-separated list of fields to return, available fields: count, id, name, notes, enable_postback_url, actual_url_params, postback_url_params
url_idIDID of the liked tracking link
Optional parameters
parameterdescription
lengthINTEGERextracts this number of conversion codes (maxmimum allowed: 100)
orderbyARRAYorders conversion codes by field, available fields: id, name, notes, enable_postback_url, actual_url_params, postback_url_params
searchSTRINGfilters conversion codes to be extracted by searching them
sortSTRINGsorts conversion codes in ascending (ASC) or descending (DESC) order
startINTEGERstarts to extract conversion codes from this position
Return values
parameterdescription
count[OPTIONAL] total number of conversion codes, returned only if count is passed in fields
dataarray containing information on the conversion codes, returned information depends on the fields parameter.

/urls/count

access: [READ]

This method returns the number of user's urls.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/count?project_id=ac24c892115e9daa4171dcdf37ae41c9

Query parameters

project_id = ac24c892115e9daa4171dcdf37ae41c9

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 9426
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/count?project_id=ac24c892115e9daa4171dcdf37ae41c9&format=xml

Query parameters

project_id = ac24c892115e9daa4171dcdf37ae41c9
    format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>9426</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/count?project_id=ac24c892115e9daa4171dcdf37ae41c9&format=txt

Query parameters

project_id = ac24c892115e9daa4171dcdf37ae41c9
    format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=9426

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/count?project_id=ac24c892115e9daa4171dcdf37ae41c9&format=plain

Query parameters

project_id = ac24c892115e9daa4171dcdf37ae41c9
    format = plain

Response

9426
Optional parameters
parameterdescription
end_dateDATEsee i1/urls/list for details
filterSTRINGsee i1/urls/list for details
optionSTRINGsee i1/urls/list for details
project_idIDsee i1/urls/list for details
searchSTRINGsee i1/urls/list for details
start_dateDATEsee i1/urls/list for details
whereSTRINGsee i1/urls/list for details
with_alertsBOOLEANsee i1/urls/list for details
Return values
parameterdescription
counttotal number of tracking links

/urls/ctas

/urls/ctas/clone

access: [WRITE]

Clone the CTA configuration from a tracking link to another.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/ctas/clone?from_url_id=64d7889c9cca5000439f50cb4d6c9d5e&to_url_id=40bfde06c6ed3f3a80e0408cd6f741bf

Query parameters

from_url_id = 64d7889c9cca5000439f50cb4d6c9d5e
  to_url_id = 40bfde06c6ed3f3a80e0408cd6f741bf

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "cloned": 0
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/ctas/clone?from_url_id=64d7889c9cca5000439f50cb4d6c9d5e&to_url_id=40bfde06c6ed3f3a80e0408cd6f741bf&format=xml

Query parameters

from_url_id = 64d7889c9cca5000439f50cb4d6c9d5e
  to_url_id = 40bfde06c6ed3f3a80e0408cd6f741bf
     format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <cloned>0</cloned>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/ctas/clone?from_url_id=64d7889c9cca5000439f50cb4d6c9d5e&to_url_id=40bfde06c6ed3f3a80e0408cd6f741bf&format=txt

Query parameters

from_url_id = 64d7889c9cca5000439f50cb4d6c9d5e
  to_url_id = 40bfde06c6ed3f3a80e0408cd6f741bf
     format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_cloned=0

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/ctas/clone?from_url_id=64d7889c9cca5000439f50cb4d6c9d5e&to_url_id=40bfde06c6ed3f3a80e0408cd6f741bf&format=plain

Query parameters

from_url_id = 64d7889c9cca5000439f50cb4d6c9d5e
  to_url_id = 40bfde06c6ed3f3a80e0408cd6f741bf
     format = plain

Response

0
Required parameters
parameterdescription
from_url_idIDID of the tracking link you want to copy the CTA configuration from
to_url_idIDID of the tracking link you want to copy the CTA configuration to
Return values
parameterdescription
cloned1 on success, 0 otherwise

/urls/ctas/delete

access: [WRITE]

Unset a call to action for a short URL.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/ctas/delete?url_id=aa0dd0e074892d3cdefd6d29fa04691d

Query parameters

url_id = aa0dd0e074892d3cdefd6d29fa04691d

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/ctas/delete?url_id=aa0dd0e074892d3cdefd6d29fa04691d&format=xml

Query parameters

url_id = aa0dd0e074892d3cdefd6d29fa04691d
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/ctas/delete?url_id=aa0dd0e074892d3cdefd6d29fa04691d&format=txt

Query parameters

url_id = aa0dd0e074892d3cdefd6d29fa04691d
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/ctas/delete?url_id=aa0dd0e074892d3cdefd6d29fa04691d&format=plain

Query parameters

url_id = aa0dd0e074892d3cdefd6d29fa04691d
format = plain

Response

1
Required parameters
parameterdescription
url_idIDID of the tracking link from which to remove the CTA
Optional parameters
parameterdescription
idIDID of the CTA to remove
Return values
parameterdescription
deleted1 on success, 0 otherwise

/urls/ctas/edit

access: [WRITE]

Set a call to action for a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/ctas/edit?url_id=38b3e9bed93261c4dc471d99147978ea&id=754176e70d793261642f15467858fcc1

Query parameters

url_id = 38b3e9bed93261c4dc471d99147978ea
    id = 754176e70d793261642f15467858fcc1

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "added": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/ctas/edit?url_id=38b3e9bed93261c4dc471d99147978ea&id=754176e70d793261642f15467858fcc1&format=xml

Query parameters

url_id = 38b3e9bed93261c4dc471d99147978ea
    id = 754176e70d793261642f15467858fcc1
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <added>1</added>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/ctas/edit?url_id=38b3e9bed93261c4dc471d99147978ea&id=754176e70d793261642f15467858fcc1&format=txt

Query parameters

url_id = 38b3e9bed93261c4dc471d99147978ea
    id = 754176e70d793261642f15467858fcc1
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_added=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/ctas/edit?url_id=38b3e9bed93261c4dc471d99147978ea&id=754176e70d793261642f15467858fcc1&format=plain

Query parameters

url_id = 38b3e9bed93261c4dc471d99147978ea
    id = 754176e70d793261642f15467858fcc1
format = plain

Response

1
Required parameters
parameterdescription
idIDID of the CTA to associate to the tracking link
url_idIDID of the tracking link
Return values
parameterdescription
added1 on success, 0 otherwise

/urls/ctas/info

access: [READ]

Get information for a CTA that is linked to a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/ctas/info?fields=id,type,name&url_id=351d442c527ca9d0b113058356523d55

Query parameters

fields = id,type,name
url_id = 351d442c527ca9d0b113058356523d55

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "8e3a061d7b7f3b7955d9be7150a03435",
    "type": "button",
    "name": "this is a button CTA"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/ctas/info?fields=id,type,name&url_id=351d442c527ca9d0b113058356523d55&format=xml

Query parameters

fields = id,type,name
url_id = 351d442c527ca9d0b113058356523d55
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>8e3a061d7b7f3b7955d9be7150a03435</id>  
    <type>button</type>  
    <name>this is a button CTA</name>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/ctas/info?fields=id,type,name&url_id=351d442c527ca9d0b113058356523d55&format=txt

Query parameters

fields = id,type,name
url_id = 351d442c527ca9d0b113058356523d55
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=8e3a061d7b7f3b7955d9be7150a03435
result_type=button
result_name=this is a button CTA

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/ctas/info?fields=id,type,name&url_id=351d442c527ca9d0b113058356523d55&format=plain

Query parameters

fields = id,type,name
url_id = 351d442c527ca9d0b113058356523d55
format = plain

Response

8e3a061d7b7f3b7955d9be7150a03435
button
this is a button CTA
Required parameters
parameterdescription
fieldsARRAYcomma-separated list of fields to return, available fields: id, type, name
url_idIDID of the liked tracking link
Return values
parameterdescription
id[OPTIONAL] ID of the CTA, only if id is passed in fields
name[OPTIONAL] name of the CTA, only if name is passed in fields
type[OPTIONAL] type of the CTA, only if type is passed in fields

/urls/ctas/previews

/urls/ctas/previews/check

access: [WRITE]

Check if a page preview is associated with a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/ctas/previews/check?url_id=128b21ecd4ae79e8712a8d291b25d53c

Query parameters

url_id = 128b21ecd4ae79e8712a8d291b25d53c

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "enabled": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/ctas/previews/check?url_id=128b21ecd4ae79e8712a8d291b25d53c&format=xml

Query parameters

url_id = 128b21ecd4ae79e8712a8d291b25d53c
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <enabled>1</enabled>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/ctas/previews/check?url_id=128b21ecd4ae79e8712a8d291b25d53c&format=txt

Query parameters

url_id = 128b21ecd4ae79e8712a8d291b25d53c
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_enabled=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/ctas/previews/check?url_id=128b21ecd4ae79e8712a8d291b25d53c&format=plain

Query parameters

url_id = 128b21ecd4ae79e8712a8d291b25d53c
format = plain

Response

1
Required parameters
parameterdescription
url_idIDID of the tracking link
Return values
parameterdescription
enabled1 if a page preview is associated with the tracking link, 0 otherwise
/urls/ctas/previews/extract

access: [WRITE]

Extract a page preview for the destination URL of a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/ctas/previews/extract?url_id=11fda213e3482ae3a3b599569b14d33b

Query parameters

url_id = 11fda213e3482ae3a3b599569b14d33b

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "extracted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/ctas/previews/extract?url_id=11fda213e3482ae3a3b599569b14d33b&format=xml

Query parameters

url_id = 11fda213e3482ae3a3b599569b14d33b
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <extracted>1</extracted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/ctas/previews/extract?url_id=11fda213e3482ae3a3b599569b14d33b&format=txt

Query parameters

url_id = 11fda213e3482ae3a3b599569b14d33b
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_extracted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/ctas/previews/extract?url_id=11fda213e3482ae3a3b599569b14d33b&format=plain

Query parameters

url_id = 11fda213e3482ae3a3b599569b14d33b
format = plain

Response

1
Required parameters
parameterdescription
url_idIDID of the tracking link
Optional parameters
parameterdescription
aiBOOLEAN1 to enable the AI extraction, default value ai = 0
Return values
parameterdescription
extracted1 on success, 0 otherwise
/urls/ctas/previews/info

access: [READ]

Return a page preview info for the destination URL of a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/ctas/previews/info?url_id=92d3b51247a97b86d1954a5012a046ee

Query parameters

url_id = 92d3b51247a97b86d1954a5012a046ee

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "info": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/ctas/previews/info?url_id=92d3b51247a97b86d1954a5012a046ee&format=xml

Query parameters

url_id = 92d3b51247a97b86d1954a5012a046ee
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <info>1</info>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/ctas/previews/info?url_id=92d3b51247a97b86d1954a5012a046ee&format=txt

Query parameters

url_id = 92d3b51247a97b86d1954a5012a046ee
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_info=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/ctas/previews/info?url_id=92d3b51247a97b86d1954a5012a046ee&format=plain

Query parameters

url_id = 92d3b51247a97b86d1954a5012a046ee
format = plain

Response

1
Required parameters
parameterdescription
url_idIDID of the tracking link
Return values
parameterdescription
info1 on success, 0 otherwise
/urls/ctas/previews/preview

access: [WRITE]

Return a page preview HTML for the destination URL of a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/ctas/previews/preview?url_id=8e9325f8f58751b6651ee1f40f4a500e

Query parameters

url_id = 8e9325f8f58751b6651ee1f40f4a500e

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "html": "<html><body>...<\/body><\/html>"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/ctas/previews/preview?url_id=8e9325f8f58751b6651ee1f40f4a500e&format=xml

Query parameters

url_id = 8e9325f8f58751b6651ee1f40f4a500e
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <html><[CDATA[&lt;html&gt;&lt;body&gt;...&lt;/body&gt;&lt;/html&gt;]]></html>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/ctas/previews/preview?url_id=8e9325f8f58751b6651ee1f40f4a500e&format=txt

Query parameters

url_id = 8e9325f8f58751b6651ee1f40f4a500e
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_html=&lt;html&gt;&lt;body&gt;...&lt;/body&gt;&lt;/html&gt;

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/ctas/previews/preview?url_id=8e9325f8f58751b6651ee1f40f4a500e&format=plain

Query parameters

url_id = 8e9325f8f58751b6651ee1f40f4a500e
format = plain

Response

&lt;html&gt;&lt;body&gt;...&lt;/body&gt;&lt;/html&gt;
Required parameters
parameterdescription
url_idIDID of the tracking link
Optional parameters
parameterdescription
return_htmlBOOLEAN1 to return HTML, 0 to return JSON containing the html field, default value return_html = 0
Return values
parameterdescription
[BINARY DATA][OPTIONAL] raw HTML content for the page preview, returned if return_html = 1
html[OPTIONAL] HTML for the page preview, returned if return_html = 0

access: [READ]

Extract App Links information from a given URL.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/deeplinks/al?url=https%3A%2F%2Fwww.facebook.com%2Fgroups%2F1234567890%2F

Query parameters

url = https://www.facebook.com/groups/1234567890/

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "android": {
      "app_name": "Facebook",
      "package": "com.facebook.katana",
      "uri_scheme": "fb:\/\/group\/1234567890"
    },
    "ios": {
      "app_name": "Facebook",
      "app_store_id": "284882215",
      "uri_scheme": "fb:\/\/group\/?id=1234567890"
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/deeplinks/al?url=https%3A%2F%2Fwww.facebook.com%2Fgroups%2F1234567890%2F&format=xml

Query parameters

   url = https://www.facebook.com/groups/1234567890/
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <android>
      <app_name>Facebook</app_name>  
      <package>com.facebook.katana</package>  
      <uri_scheme>fb://group/1234567890</uri_scheme>  
    </android>  
    <ios>
      <app_name>Facebook</app_name>  
      <app_store_id>284882215</app_store_id>  
      <uri_scheme>fb://group/?id=1234567890</uri_scheme>  
    </ios>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/deeplinks/al?url=https%3A%2F%2Fwww.facebook.com%2Fgroups%2F1234567890%2F&format=txt

Query parameters

   url = https://www.facebook.com/groups/1234567890/
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_android_app_name=Facebook
result_android_package=com.facebook.katana
result_android_uri_scheme=fb://group/1234567890
result_ios_app_name=Facebook
result_ios_app_store_id=284882215
result_ios_uri_scheme=fb://group/?id=1234567890

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/deeplinks/al?url=https%3A%2F%2Fwww.facebook.com%2Fgroups%2F1234567890%2F&format=plain

Query parameters

   url = https://www.facebook.com/groups/1234567890/
format = plain

Response

Facebook
com.facebook.katana
fb://group/1234567890
Facebook
284882215
fb://group/?id=1234567890
Required parameters
parameterdescription
urlSTRINGURL to be scraped
Return values
parameterdescription
dataExtracted App Link tags

access: [WRITE]

Clone the deep link configuration from a tracking link to another.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/deeplinks/clone?from_url_id=b4d5afbaa8bd4683ce7cfdb72cb2c495&to_url_id=21ff52c68f3c88339559bb01890ff372

Query parameters

from_url_id = b4d5afbaa8bd4683ce7cfdb72cb2c495
  to_url_id = 21ff52c68f3c88339559bb01890ff372

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "cloned": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/deeplinks/clone?from_url_id=b4d5afbaa8bd4683ce7cfdb72cb2c495&to_url_id=21ff52c68f3c88339559bb01890ff372&format=xml

Query parameters

from_url_id = b4d5afbaa8bd4683ce7cfdb72cb2c495
  to_url_id = 21ff52c68f3c88339559bb01890ff372
     format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <cloned>1</cloned>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/deeplinks/clone?from_url_id=b4d5afbaa8bd4683ce7cfdb72cb2c495&to_url_id=21ff52c68f3c88339559bb01890ff372&format=txt

Query parameters

from_url_id = b4d5afbaa8bd4683ce7cfdb72cb2c495
  to_url_id = 21ff52c68f3c88339559bb01890ff372
     format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_cloned=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/deeplinks/clone?from_url_id=b4d5afbaa8bd4683ce7cfdb72cb2c495&to_url_id=21ff52c68f3c88339559bb01890ff372&format=plain

Query parameters

from_url_id = b4d5afbaa8bd4683ce7cfdb72cb2c495
  to_url_id = 21ff52c68f3c88339559bb01890ff372
     format = plain

Response

1
Required parameters
parameterdescription
from_url_idIDID of the tracking link you want to copy the deep link configuration from
to_url_idIDID of the tracking link you want to the deep link configuration to
Return values
parameterdescription
cloned1 on success, 0 otherwise

access: [WRITE]

Unset (delete) a deep link for a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/deeplinks/delete?id=119500e6e9f8fb84cdb67a1965d907b1

Query parameters

id = 119500e6e9f8fb84cdb67a1965d907b1

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/deeplinks/delete?id=119500e6e9f8fb84cdb67a1965d907b1&format=xml

Query parameters

    id = 119500e6e9f8fb84cdb67a1965d907b1
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/deeplinks/delete?id=119500e6e9f8fb84cdb67a1965d907b1&format=txt

Query parameters

    id = 119500e6e9f8fb84cdb67a1965d907b1
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/deeplinks/delete?id=119500e6e9f8fb84cdb67a1965d907b1&format=plain

Query parameters

    id = 119500e6e9f8fb84cdb67a1965d907b1
format = plain

Response

1
Required parameters
parameterdescription
idIDID of the tracking link from which to remove a deep link configration
Return values
parameterdescription
deleted1 on success, 0 otherwise

access: [WRITE]

Set deep link settings for a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/deeplinks/edit?id=ab279c1e7583c823bfa1b84397ec602d

Query parameters

id = ab279c1e7583c823bfa1b84397ec602d

Post parameters

settings=%7B%22params%22%3A%5B%5D%2C%22default_url%22%3A%22https%3A%2F%2Fjoturl.com%2F%22%2C%22desktop_settings%22%3A%22default%22%2C%22desktop_redirect_url%22%3A%22%22%2C%22android_redirect_url%22%3A%22%22%2C%22android_settings%22%3A%22deeplink%22%2C%22android_uri_scheme%22%3A%22customUriScheme%3A%2F%2Fopen%22%2C%22android_package_name%22%3A%22com.joturl.example%22%2C%22android_fallback%22%3A%22redirect%22%2C%22android_fallback_redirect_url%22%3A%22https%3A%2F%2Fjoturl.com%2F%22%2C%22ios_settings%22%3A%22default%22%2C%22ios_redirect_url%22%3A%22%22%2C%22ios_uri_scheme%22%3A%22%22%2C%22ios_store_url%22%3A%22%22%2C%22ios_fallback%22%3A%22store%22%2C%22ios_fallback_redirect_url%22%3A%22%22%2C%22og_title%22%3A%22%22%3A%22%22%2C%22og_image%22%3A%22%22%7D

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "enabled": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/deeplinks/edit?id=ab279c1e7583c823bfa1b84397ec602d&format=xml

Query parameters

    id = ab279c1e7583c823bfa1b84397ec602d
format = xml

Post parameters

settings=%7B%22params%22%3A%5B%5D%2C%22default_url%22%3A%22https%3A%2F%2Fjoturl.com%2F%22%2C%22desktop_settings%22%3A%22default%22%2C%22desktop_redirect_url%22%3A%22%22%2C%22android_redirect_url%22%3A%22%22%2C%22android_settings%22%3A%22deeplink%22%2C%22android_uri_scheme%22%3A%22customUriScheme%3A%2F%2Fopen%22%2C%22android_package_name%22%3A%22com.joturl.example%22%2C%22android_fallback%22%3A%22redirect%22%2C%22android_fallback_redirect_url%22%3A%22https%3A%2F%2Fjoturl.com%2F%22%2C%22ios_settings%22%3A%22default%22%2C%22ios_redirect_url%22%3A%22%22%2C%22ios_uri_scheme%22%3A%22%22%2C%22ios_store_url%22%3A%22%22%2C%22ios_fallback%22%3A%22store%22%2C%22ios_fallback_redirect_url%22%3A%22%22%2C%22og_title%22%3A%22%22%3A%22%22%2C%22og_image%22%3A%22%22%7D

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <enabled>1</enabled>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/deeplinks/edit?id=ab279c1e7583c823bfa1b84397ec602d&format=txt

Query parameters

    id = ab279c1e7583c823bfa1b84397ec602d
format = txt

Post parameters

settings=%7B%22params%22%3A%5B%5D%2C%22default_url%22%3A%22https%3A%2F%2Fjoturl.com%2F%22%2C%22desktop_settings%22%3A%22default%22%2C%22desktop_redirect_url%22%3A%22%22%2C%22android_redirect_url%22%3A%22%22%2C%22android_settings%22%3A%22deeplink%22%2C%22android_uri_scheme%22%3A%22customUriScheme%3A%2F%2Fopen%22%2C%22android_package_name%22%3A%22com.joturl.example%22%2C%22android_fallback%22%3A%22redirect%22%2C%22android_fallback_redirect_url%22%3A%22https%3A%2F%2Fjoturl.com%2F%22%2C%22ios_settings%22%3A%22default%22%2C%22ios_redirect_url%22%3A%22%22%2C%22ios_uri_scheme%22%3A%22%22%2C%22ios_store_url%22%3A%22%22%2C%22ios_fallback%22%3A%22store%22%2C%22ios_fallback_redirect_url%22%3A%22%22%2C%22og_title%22%3A%22%22%3A%22%22%2C%22og_image%22%3A%22%22%7D

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_enabled=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/deeplinks/edit?id=ab279c1e7583c823bfa1b84397ec602d&format=plain

Query parameters

    id = ab279c1e7583c823bfa1b84397ec602d
format = plain

Post parameters

settings=%7B%22params%22%3A%5B%5D%2C%22default_url%22%3A%22https%3A%2F%2Fjoturl.com%2F%22%2C%22desktop_settings%22%3A%22default%22%2C%22desktop_redirect_url%22%3A%22%22%2C%22android_redirect_url%22%3A%22%22%2C%22android_settings%22%3A%22deeplink%22%2C%22android_uri_scheme%22%3A%22customUriScheme%3A%2F%2Fopen%22%2C%22android_package_name%22%3A%22com.joturl.example%22%2C%22android_fallback%22%3A%22redirect%22%2C%22android_fallback_redirect_url%22%3A%22https%3A%2F%2Fjoturl.com%2F%22%2C%22ios_settings%22%3A%22default%22%2C%22ios_redirect_url%22%3A%22%22%2C%22ios_uri_scheme%22%3A%22%22%2C%22ios_store_url%22%3A%22%22%2C%22ios_fallback%22%3A%22store%22%2C%22ios_fallback_redirect_url%22%3A%22%22%2C%22og_title%22%3A%22%22%3A%22%22%2C%22og_image%22%3A%22%22%7D

Response

1
Required parameters
parameterdescription
idIDtracking link ID for which you want to edit the app deep link configuration
settingsJSONstringified JSON of the app deep link configuration, see i1/urls/deeplinks/info for details
Return values
parameterdescription
enabled1 if the app deep link option has been successfully enabled, 0 otherwise

access: [READ]

Get the package of a Huawei Quick App from its ID.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/deeplinks/huawei/quickapps/id2package?id=C1234567890

Query parameters

id = C1234567890

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "package": "com.example.quickapp"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/deeplinks/huawei/quickapps/id2package?id=C1234567890&format=xml

Query parameters

    id = C1234567890
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <package>com.example.quickapp</package>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/deeplinks/huawei/quickapps/id2package?id=C1234567890&format=txt

Query parameters

    id = C1234567890
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_package=com.example.quickapp

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/deeplinks/huawei/quickapps/id2package?id=C1234567890&format=plain

Query parameters

    id = C1234567890
format = plain

Response

com.example.quickapp
Required parameters
parameterdescription
idSTRINGID of a Huawei Quick App
Return values
parameterdescription
packageThe Huawei Quick App package that matches the passed id

access: [READ]

Get a deep link settings for a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/deeplinks/info?id=b707538ebc6a9db01b81820134ba255f

Query parameters

id = b707538ebc6a9db01b81820134ba255f

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "settings": "{\"params\":[{\"key\":\"a\",\"value\":\"b\"},{\"key\":\"c\",\"value\":\"d\"}],\"default_url\":\"https:\\\/\\\/joturl.com\\\/\",\"desktop_settings\":\"default\",\"desktop_redirect_url\":\"\",\"android_redirect_url\":\"\",\"android_settings\":\"deeplink\",\"android_uri_scheme\":\"customUriScheme:\\\/\\\/open\",\"android_package_name\":\"com.joturl.example\",\"android_fallback\":\"redirect\",\"android_fallback_redirect_url\":\"https:\\\/\\\/joturl.com\\\/\",\"ios_settings\":\"default\",\"ios_redirect_url\":\"\",\"ios_uri_scheme\":\"\",\"ios_store_url\":\"\",\"ios_fallback\":\"store\",\"ios_fallback_redirect_url\":\"\",\"og_title\":\"\",\"og_description\":\"\",\"og_image\":\"\"}"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/deeplinks/info?id=b707538ebc6a9db01b81820134ba255f&format=xml

Query parameters

    id = b707538ebc6a9db01b81820134ba255f
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <settings>{"params":[{"key":"a","value":"b"},{"key":"c","value":"d"}],"default_url":"https:\/\/joturl.com\/","desktop_settings":"default","desktop_redirect_url":"","android_redirect_url":"","android_settings":"deeplink","android_uri_scheme":"customUriScheme:\/\/open","android_package_name":"com.joturl.example","android_fallback":"redirect","android_fallback_redirect_url":"https:\/\/joturl.com\/","ios_settings":"default","ios_redirect_url":"","ios_uri_scheme":"","ios_store_url":"","ios_fallback":"store","ios_fallback_redirect_url":"","og_title":"","og_description":"","og_image":""}</settings>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/deeplinks/info?id=b707538ebc6a9db01b81820134ba255f&format=txt

Query parameters

    id = b707538ebc6a9db01b81820134ba255f
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_settings={"params":[{"key":"a","value":"b"},{"key":"c","value":"d"}],"default_url":"https:\/\/joturl.com\/","desktop_settings":"default","desktop_redirect_url":"","android_redirect_url":"","android_settings":"deeplink","android_uri_scheme":"customUriScheme:\/\/open","android_package_name":"com.joturl.example","android_fallback":"redirect","android_fallback_redirect_url":"https:\/\/joturl.com\/","ios_settings":"default","ios_redirect_url":"","ios_uri_scheme":"","ios_store_url":"","ios_fallback":"store","ios_fallback_redirect_url":"","og_title":"","og_description":"","og_image":""}

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/deeplinks/info?id=b707538ebc6a9db01b81820134ba255f&format=plain

Query parameters

    id = b707538ebc6a9db01b81820134ba255f
format = plain

Response

{"params":[{"key":"a","value":"b"},{"key":"c","value":"d"}],"default_url":"https:\/\/joturl.com\/","desktop_settings":"default","desktop_redirect_url":"","android_redirect_url":"","android_settings":"deeplink","android_uri_scheme":"customUriScheme:\/\/open","android_package_name":"com.joturl.example","android_fallback":"redirect","android_fallback_redirect_url":"https:\/\/joturl.com\/","ios_settings":"default","ios_redirect_url":"","ios_uri_scheme":"","ios_store_url":"","ios_fallback":"store","ios_fallback_redirect_url":"","og_title":"","og_description":"","og_image":""}
Required parameters
parameterdescription
idIDtracking link ID to extract deep link configuration for
Return values
parameterdescription
settingsstringified JSON of the deep link configuration

access: [READ]

Extract Open Graph information from a given URL.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/deeplinks/og?url=https%3A%2F%2Fwww.facebook.com%2F

Query parameters

url = https://www.facebook.com/

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": {
      "site_name": "Facebook",
      "url": "https:\/\/www.facebook.com\/",
      "image": "https:\/\/www.facebook.com\/images\/fb_icon_325x325.png",
      "locale": "en_US",
      "title": "Facebook - Log In or Sign Up",
      "description": "Create an account or log into Facebook. Connect with friends, family and other people you know. Share photos and videos, send messages and get updates."
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/deeplinks/og?url=https%3A%2F%2Fwww.facebook.com%2F&format=xml

Query parameters

   url = https://www.facebook.com/
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <site_name>Facebook</site_name>  
      <url>https://www.facebook.com/</url>  
      <image>https://www.facebook.com/images/fb_icon_325x325.png</image>  
      <locale>en_US</locale>  
      <title>Facebook - Log In or Sign Up</title>  
      <description>Create an account or log into Facebook. Connect with friends, family and other people you know. Share photos and videos, send messages and get updates.</description>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/deeplinks/og?url=https%3A%2F%2Fwww.facebook.com%2F&format=txt

Query parameters

   url = https://www.facebook.com/
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_site_name=Facebook
result_data_url=https://www.facebook.com/
result_data_image=https://www.facebook.com/images/fb_icon_325x325.png
result_data_locale=en_US
result_data_title=Facebook - Log In or Sign Up
result_data_description=Create an account or log into Facebook. Connect with friends, family and other people you know. Share photos and videos, send messages and get updates.

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/deeplinks/og?url=https%3A%2F%2Fwww.facebook.com%2F&format=plain

Query parameters

   url = https://www.facebook.com/
format = plain

Response

Facebook
https://www.facebook.com/
https://www.facebook.com/images/fb_icon_325x325.png
en_US
Facebook - Log In or Sign Up
Create an account or log into Facebook. Connect with friends, family and other people you know. Share photos and videos, send messages and get updates.
Required parameters
parameterdescription
urlSTRINGURL to be scraped
Return values
parameterdescription
dataExtracted Open Graph tags

/urls/delete

access: [WRITE]

This method deletes a set of tracking links by using the parameter ids.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/delete?ids=7379f6b6b9fe131f5c0c4b016b4298fa,f374f77aa0c52a0b2f453dcf48d6e0c9,e407dc844c8a011cefcba7d63db767ca

Query parameters

ids = 7379f6b6b9fe131f5c0c4b016b4298fa,f374f77aa0c52a0b2f453dcf48d6e0c9,e407dc844c8a011cefcba7d63db767ca

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 3
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/delete?ids=7379f6b6b9fe131f5c0c4b016b4298fa,f374f77aa0c52a0b2f453dcf48d6e0c9,e407dc844c8a011cefcba7d63db767ca&format=xml

Query parameters

   ids = 7379f6b6b9fe131f5c0c4b016b4298fa,f374f77aa0c52a0b2f453dcf48d6e0c9,e407dc844c8a011cefcba7d63db767ca
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>3</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/delete?ids=7379f6b6b9fe131f5c0c4b016b4298fa,f374f77aa0c52a0b2f453dcf48d6e0c9,e407dc844c8a011cefcba7d63db767ca&format=txt

Query parameters

   ids = 7379f6b6b9fe131f5c0c4b016b4298fa,f374f77aa0c52a0b2f453dcf48d6e0c9,e407dc844c8a011cefcba7d63db767ca
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=3

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/delete?ids=7379f6b6b9fe131f5c0c4b016b4298fa,f374f77aa0c52a0b2f453dcf48d6e0c9,e407dc844c8a011cefcba7d63db767ca&format=plain

Query parameters

   ids = 7379f6b6b9fe131f5c0c4b016b4298fa,f374f77aa0c52a0b2f453dcf48d6e0c9,e407dc844c8a011cefcba7d63db767ca
format = plain

Response

3

Example 5 (json)

Request

https://joturl.com/a/i1/urls/delete?ids=e3a2456b3f50bd352530c50d67d8b171,2918c15965af29e450ffad57b163987a,9c4d109f84962ed8903585fcb1cd3ed4

Query parameters

ids = e3a2456b3f50bd352530c50d67d8b171,2918c15965af29e450ffad57b163987a,9c4d109f84962ed8903585fcb1cd3ed4

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "ids": [
      "2918c15965af29e450ffad57b163987a",
      "9c4d109f84962ed8903585fcb1cd3ed4"
    ],
    "deleted": 1
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/urls/delete?ids=e3a2456b3f50bd352530c50d67d8b171,2918c15965af29e450ffad57b163987a,9c4d109f84962ed8903585fcb1cd3ed4&format=xml

Query parameters

   ids = e3a2456b3f50bd352530c50d67d8b171,2918c15965af29e450ffad57b163987a,9c4d109f84962ed8903585fcb1cd3ed4
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <ids>
      <i0>2918c15965af29e450ffad57b163987a</i0>  
      <i1>9c4d109f84962ed8903585fcb1cd3ed4</i1>  
    </ids>  
    <deleted>1</deleted>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/urls/delete?ids=e3a2456b3f50bd352530c50d67d8b171,2918c15965af29e450ffad57b163987a,9c4d109f84962ed8903585fcb1cd3ed4&format=txt

Query parameters

   ids = e3a2456b3f50bd352530c50d67d8b171,2918c15965af29e450ffad57b163987a,9c4d109f84962ed8903585fcb1cd3ed4
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_ids_0=2918c15965af29e450ffad57b163987a
result_ids_1=9c4d109f84962ed8903585fcb1cd3ed4
result_deleted=1

Example 8 (plain)

Request

https://joturl.com/a/i1/urls/delete?ids=e3a2456b3f50bd352530c50d67d8b171,2918c15965af29e450ffad57b163987a,9c4d109f84962ed8903585fcb1cd3ed4&format=plain

Query parameters

   ids = e3a2456b3f50bd352530c50d67d8b171,2918c15965af29e450ffad57b163987a,9c4d109f84962ed8903585fcb1cd3ed4
format = plain

Response

2918c15965af29e450ffad57b163987a
9c4d109f84962ed8903585fcb1cd3ed4
1
Required parameters
parameterdescription
idsARRAY_OF_IDScomma separated list of tracking link IDs to be deleted
Return values
parameterdescription
deletednumber of deleted tracking links
ids[OPTIONAL] list of tracking link IDs whose delete has failed, this parameter is returned only when at least one delete error has occurred

access: [WRITE]

Clone the easy deep link configuration from a tracking link to another.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/easydeeplinks/clone?from_url_id=03a867fca1c0376b8ad6b4760547430d&to_url_id=bf7938d51323bd694992dc941ee71ce5

Query parameters

from_url_id = 03a867fca1c0376b8ad6b4760547430d
  to_url_id = bf7938d51323bd694992dc941ee71ce5

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "cloned": 0
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/easydeeplinks/clone?from_url_id=03a867fca1c0376b8ad6b4760547430d&to_url_id=bf7938d51323bd694992dc941ee71ce5&format=xml

Query parameters

from_url_id = 03a867fca1c0376b8ad6b4760547430d
  to_url_id = bf7938d51323bd694992dc941ee71ce5
     format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <cloned>0</cloned>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/easydeeplinks/clone?from_url_id=03a867fca1c0376b8ad6b4760547430d&to_url_id=bf7938d51323bd694992dc941ee71ce5&format=txt

Query parameters

from_url_id = 03a867fca1c0376b8ad6b4760547430d
  to_url_id = bf7938d51323bd694992dc941ee71ce5
     format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_cloned=0

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/easydeeplinks/clone?from_url_id=03a867fca1c0376b8ad6b4760547430d&to_url_id=bf7938d51323bd694992dc941ee71ce5&format=plain

Query parameters

from_url_id = 03a867fca1c0376b8ad6b4760547430d
  to_url_id = bf7938d51323bd694992dc941ee71ce5
     format = plain

Response

0
Required parameters
parameterdescription
from_url_idIDID of the tracking link you want to copy the easy deep link configuration from
to_url_idIDID of the tracking link you want to the easy deep link configuration to
Return values
parameterdescription
cloned1 on success, 0 otherwise

access: [WRITE]

Unset (delete) an easy dee link for a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/easydeeplinks/delete?id=f6b794e55e4ee923b8c5b0e3e54c7e34

Query parameters

id = f6b794e55e4ee923b8c5b0e3e54c7e34

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/easydeeplinks/delete?id=f6b794e55e4ee923b8c5b0e3e54c7e34&format=xml

Query parameters

    id = f6b794e55e4ee923b8c5b0e3e54c7e34
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/easydeeplinks/delete?id=f6b794e55e4ee923b8c5b0e3e54c7e34&format=txt

Query parameters

    id = f6b794e55e4ee923b8c5b0e3e54c7e34
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/easydeeplinks/delete?id=f6b794e55e4ee923b8c5b0e3e54c7e34&format=plain

Query parameters

    id = f6b794e55e4ee923b8c5b0e3e54c7e34
format = plain

Response

1
Required parameters
parameterdescription
idIDID of the tracking link from which to remove an easy deep link configration
Return values
parameterdescription
deleted1 on success, 0 otherwise

access: [READ]

Find the app the passed URL is associated with (e.g., Facebook, Instagram).

Example 1 (json)

Request

https://joturl.com/a/i1/urls/easydeeplinks/detect?url=https%3A%2F%2Fwww.facebook.com%2FjotURL

Query parameters

url = https://www.facebook.com/jotURL

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "name": "Facebook",
    "category": "social"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/easydeeplinks/detect?url=https%3A%2F%2Fwww.facebook.com%2FjotURL&format=xml

Query parameters

   url = https://www.facebook.com/jotURL
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <name>Facebook</name>  
    <category>social</category>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/easydeeplinks/detect?url=https%3A%2F%2Fwww.facebook.com%2FjotURL&format=txt

Query parameters

   url = https://www.facebook.com/jotURL
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_name=Facebook
result_category=social

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/easydeeplinks/detect?url=https%3A%2F%2Fwww.facebook.com%2FjotURL&format=plain

Query parameters

   url = https://www.facebook.com/jotURL
format = plain

Response

Facebook
social
Optional parameters
parameterdescriptionmax length
urlURLURL corresponding to the app page4000
Return values
parameterdescription
categorycategory of the easy deep link provider, if available, supported categories: affiliation, business, entertainment, lifestyle, music, other, shopping, social, travel, unknown, website
namename of the easy deep link provider, if available, supported names: Adidas, AliExpress, Amazon, Apartments.com, Apple Maps, Apple Music, Apple Podcast, Best Buy, BlueSky, Booking.com, BrandCycle, Discord, Epic Games Store, Etsy, Expedia, Facebook, Flipkart, Google Docs, Google Maps, Google Sheets, Google Slides, HSN, Howl, IKEA, Instagram, Kaufland, Kickstarter, Kohl's, LINE, LTK, LinkedIn, Macy's, MagicLinks, Mavely, Medium, Mercado Livre, Messenger, Microsoft Excel, Microsoft PowerPoint, Microsoft Word, Netflix, Nordstrom, OnlyFans, Otto, Pinterest, Product Hunt, QVC, Quora, Reddit, Refersion, SHEIN, Signal, Skype, Snapchat, Spotify, Steam, Target, Telegram, Temu, The Home Depot, TikTok, TripAdvisor, Trulia, Twitch TV, Unknown, Viber, Vimeo, Walmart, WhatsApp, X, YouTube, Zendesk Support, Zillow, Zulily, eBay, iFood
real_category[OPTIONAL] category of the real easy deep link provider, see notes
real_name[OPTIONAL] name of the real easy deep link provider, see notes

access: [WRITE]

Set an easy deep link settings for a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/easydeeplinks/edit?id=b1df92ea475449e2af55e986537d74d7

Query parameters

id = b1df92ea475449e2af55e986537d74d7

Post parameters

settings=%7B%22name%22%3A%22YouTube%22%2C%22category%22%3A%22social%22%2C%22ios%22%3A%7B%22phone%22%3A%7B%22enabled%22%3A1%2C%22installed%22%3A%7B%22choice%22%3A%22scheme%22%2C%22scheme%22%3A%22vnd.youtube%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%22%2C%22custom%22%3A%22%22%2C%22alternatives%22%3A%5B%5D%7D%2C%22not_installed%22%3A%7B%22choice%22%3A%22default%22%2C%22custom%22%3A%22%22%2C%22store%22%3A%22https%3A%5C%2F%5C%2Fitunes.apple.com%5C%2Fus%5C%2Fapp%5C%2Fyoutube%5C%2Fid544007664%22%7D%2C%22deeplink_method%22%3A%22aggressive%22%7D%2C%22tablet%22%3A%7B%22enabled%22%3A1%2C%22installed%22%3A%7B%22choice%22%3A%22scheme%22%2C%22scheme%22%3A%22vnd.youtube%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%22%2C%22custom%22%3A%22%22%2C%22alternatives%22%3A%5B%5D%7D%2C%22not_installed%22%3A%7B%22choice%22%3A%22default%22%2C%22custom%22%3A%22%22%2C%22store%22%3A%22https%3A%5C%2F%5C%2Fitunes.apple.com%5C%2Fus%5C%2Fapp%5C%2Fyoutube%5C%2Fid544007664%22%7D%2C%22deeplink_method%22%3A%22aggressive%22%7D%7D%2C%22android%22%3A%7B%22phone%22%3A%7B%22enabled%22%3A1%2C%22installed%22%3A%7B%22choice%22%3A%22scheme%22%2C%22scheme%22%3A%22intent%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%23Intent%3Bpackage%3Dcom.google.android.youtube%3Bscheme%3Dhttps%3BS.browser_fallback_url%3D%7Bnot_installed%7D%3Bend%22%2C%22custom%22%3A%22%22%2C%22alternatives%22%3A%5B%5D%7D%2C%22not_installed%22%3A%7B%22choice%22%3A%22default%22%2C%22custom%22%3A%22%22%2C%22store%22%3A%22https%3A%5C%2F%5C%2Fplay.google.com%5C%2Fstore%5C%2Fapps%5C%2Fdetails%3Fid%3Dcom.google.android.youtube%22%7D%2C%22force_chrome%22%3A0%2C%22deeplink_method%22%3A%22aggressive%22%7D%2C%22tablet%22%3A%7B%22enabled%22%3A1%2C%22installed%22%3A%7B%22choice%22%3A%22scheme%22%2C%22scheme%22%3A%22intent%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%23Intent%3Bpackage%3Dcom.google.android.youtube%3Bscheme%3Dhttps%3BS.browser_fallback_url%3D%7Bnot_installed%7D%3Bend%22%2C%22custom%22%3A%22%22%2C%22alternatives%22%3A%5B%5D%7D%2C%22not_installed%22%3A%7B%22choice%22%3A%22default%22%2C%22custom%22%3A%22%22%2C%22store%22%3A%22https%3A%5C%2F%5C%2Fplay.google.com%5C%2Fstore%5C%2Fapps%5C%2Fdetails%3Fid%3Dcom.google.android.youtube%22%7D%2C%22force_chrome%22%3A0%2C%22deeplink_method%22%3A%22aggressive%22%7D%7D%2C%22default_url%22%3A%22https%3A%5C%2F%5C%2Fyoutu.be%5C%2FoBg0slZQt1g%22%2C%22info%22%3A%7B%22title%22%3A%22JotURL+-+The+all-in-one+dream+suite+for+your+marketing+links%21%22%2C%22description%22%3A%22JotUrl%3A+Boost+your+inbound+marketing+results+and+conversions%2C+with+the+best+user+experience.+www.joturl.com%22%2C%22image%22%3A%22https%3A%5C%2F%5C%2Fi.ytimg.com%5C%2Fvi%5C%2FoBg0slZQt1g%5C%2Fmaxresdefault.jpg%22%2C%22ios_url%22%3A%22vnd.youtube%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%22%2C%22ios_store_url%22%3A%22https%3A%5C%2F%5C%2Fitunes.apple.com%5C%2Fus%5C%2Fapp%5C%2Fyoutube%5C%2Fid544007664%22%2C%22android_url%22%3A%22intent%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%23Intent%3Bpackage%3Dcom.google.android.youtube%3Bscheme%3Dhttps%3BS.browser_fallback_url%3D%7Bnot_installed%7D%3Bend%22%2C%22android_store_url%22%3A%22https%3A%5C%2F%5C%2Fplay.google.com%5C%2Fstore%5C%2Fapps%5C%2Fdetails%3Fid%3Dcom.google.android.youtube%22%2C%22info%22%3A%7B%22ios%22%3A%7B%22app_name%22%3A%22YouTube%22%2C%22app_store_id%22%3A%22544007664%22%2C%22url%22%3A%22vnd.youtube%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%22%7D%2C%22android%22%3A%7B%22app_name%22%3A%22YouTube%22%2C%22package%22%3A%22com.google.android.youtube%22%2C%22url%22%3A%22intent%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%23Intent%3Bpackage%3Dcom.google.android.youtube%3Bscheme%3Dhttps%3BS.browser_fallback_url%3D%7Bnot_installed%7D%3Bend%22%7D%7D%7D%2C%22detected%22%3A%5B%22ios%22%2C%22android%22%5D%2C%22og_title%22%3A%22JotURL+-+The+all-in-one+dream+suite+for+your+marketing+links%21%22%2C%22og_description%22%3A%22JotUrl%3A+Boost+your+inbound+marketing+results+and+conversions%2C+with+the+best+user+experience.+www.joturl.com%22%2C%22og_image%22%3A%22https%3A%5C%2F%5C%2Fi.ytimg.com%5C%2Fvi%5C%2FoBg0slZQt1g%5C%2Fmaxresdefault.jpg%22%7D

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "enabled": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/easydeeplinks/edit?id=b1df92ea475449e2af55e986537d74d7&format=xml

Query parameters

    id = b1df92ea475449e2af55e986537d74d7
format = xml

Post parameters

settings=%7B%22name%22%3A%22YouTube%22%2C%22category%22%3A%22social%22%2C%22ios%22%3A%7B%22phone%22%3A%7B%22enabled%22%3A1%2C%22installed%22%3A%7B%22choice%22%3A%22scheme%22%2C%22scheme%22%3A%22vnd.youtube%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%22%2C%22custom%22%3A%22%22%2C%22alternatives%22%3A%5B%5D%7D%2C%22not_installed%22%3A%7B%22choice%22%3A%22default%22%2C%22custom%22%3A%22%22%2C%22store%22%3A%22https%3A%5C%2F%5C%2Fitunes.apple.com%5C%2Fus%5C%2Fapp%5C%2Fyoutube%5C%2Fid544007664%22%7D%2C%22deeplink_method%22%3A%22aggressive%22%7D%2C%22tablet%22%3A%7B%22enabled%22%3A1%2C%22installed%22%3A%7B%22choice%22%3A%22scheme%22%2C%22scheme%22%3A%22vnd.youtube%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%22%2C%22custom%22%3A%22%22%2C%22alternatives%22%3A%5B%5D%7D%2C%22not_installed%22%3A%7B%22choice%22%3A%22default%22%2C%22custom%22%3A%22%22%2C%22store%22%3A%22https%3A%5C%2F%5C%2Fitunes.apple.com%5C%2Fus%5C%2Fapp%5C%2Fyoutube%5C%2Fid544007664%22%7D%2C%22deeplink_method%22%3A%22aggressive%22%7D%7D%2C%22android%22%3A%7B%22phone%22%3A%7B%22enabled%22%3A1%2C%22installed%22%3A%7B%22choice%22%3A%22scheme%22%2C%22scheme%22%3A%22intent%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%23Intent%3Bpackage%3Dcom.google.android.youtube%3Bscheme%3Dhttps%3BS.browser_fallback_url%3D%7Bnot_installed%7D%3Bend%22%2C%22custom%22%3A%22%22%2C%22alternatives%22%3A%5B%5D%7D%2C%22not_installed%22%3A%7B%22choice%22%3A%22default%22%2C%22custom%22%3A%22%22%2C%22store%22%3A%22https%3A%5C%2F%5C%2Fplay.google.com%5C%2Fstore%5C%2Fapps%5C%2Fdetails%3Fid%3Dcom.google.android.youtube%22%7D%2C%22force_chrome%22%3A0%2C%22deeplink_method%22%3A%22aggressive%22%7D%2C%22tablet%22%3A%7B%22enabled%22%3A1%2C%22installed%22%3A%7B%22choice%22%3A%22scheme%22%2C%22scheme%22%3A%22intent%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%23Intent%3Bpackage%3Dcom.google.android.youtube%3Bscheme%3Dhttps%3BS.browser_fallback_url%3D%7Bnot_installed%7D%3Bend%22%2C%22custom%22%3A%22%22%2C%22alternatives%22%3A%5B%5D%7D%2C%22not_installed%22%3A%7B%22choice%22%3A%22default%22%2C%22custom%22%3A%22%22%2C%22store%22%3A%22https%3A%5C%2F%5C%2Fplay.google.com%5C%2Fstore%5C%2Fapps%5C%2Fdetails%3Fid%3Dcom.google.android.youtube%22%7D%2C%22force_chrome%22%3A0%2C%22deeplink_method%22%3A%22aggressive%22%7D%7D%2C%22default_url%22%3A%22https%3A%5C%2F%5C%2Fyoutu.be%5C%2FoBg0slZQt1g%22%2C%22info%22%3A%7B%22title%22%3A%22JotURL+-+The+all-in-one+dream+suite+for+your+marketing+links%21%22%2C%22description%22%3A%22JotUrl%3A+Boost+your+inbound+marketing+results+and+conversions%2C+with+the+best+user+experience.+www.joturl.com%22%2C%22image%22%3A%22https%3A%5C%2F%5C%2Fi.ytimg.com%5C%2Fvi%5C%2FoBg0slZQt1g%5C%2Fmaxresdefault.jpg%22%2C%22ios_url%22%3A%22vnd.youtube%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%22%2C%22ios_store_url%22%3A%22https%3A%5C%2F%5C%2Fitunes.apple.com%5C%2Fus%5C%2Fapp%5C%2Fyoutube%5C%2Fid544007664%22%2C%22android_url%22%3A%22intent%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%23Intent%3Bpackage%3Dcom.google.android.youtube%3Bscheme%3Dhttps%3BS.browser_fallback_url%3D%7Bnot_installed%7D%3Bend%22%2C%22android_store_url%22%3A%22https%3A%5C%2F%5C%2Fplay.google.com%5C%2Fstore%5C%2Fapps%5C%2Fdetails%3Fid%3Dcom.google.android.youtube%22%2C%22info%22%3A%7B%22ios%22%3A%7B%22app_name%22%3A%22YouTube%22%2C%22app_store_id%22%3A%22544007664%22%2C%22url%22%3A%22vnd.youtube%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%22%7D%2C%22android%22%3A%7B%22app_name%22%3A%22YouTube%22%2C%22package%22%3A%22com.google.android.youtube%22%2C%22url%22%3A%22intent%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%23Intent%3Bpackage%3Dcom.google.android.youtube%3Bscheme%3Dhttps%3BS.browser_fallback_url%3D%7Bnot_installed%7D%3Bend%22%7D%7D%7D%2C%22detected%22%3A%5B%22ios%22%2C%22android%22%5D%2C%22og_title%22%3A%22JotURL+-+The+all-in-one+dream+suite+for+your+marketing+links%21%22%2C%22og_description%22%3A%22JotUrl%3A+Boost+your+inbound+marketing+results+and+conversions%2C+with+the+best+user+experience.+www.joturl.com%22%2C%22og_image%22%3A%22https%3A%5C%2F%5C%2Fi.ytimg.com%5C%2Fvi%5C%2FoBg0slZQt1g%5C%2Fmaxresdefault.jpg%22%7D

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <enabled>1</enabled>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/easydeeplinks/edit?id=b1df92ea475449e2af55e986537d74d7&format=txt

Query parameters

    id = b1df92ea475449e2af55e986537d74d7
format = txt

Post parameters

settings=%7B%22name%22%3A%22YouTube%22%2C%22category%22%3A%22social%22%2C%22ios%22%3A%7B%22phone%22%3A%7B%22enabled%22%3A1%2C%22installed%22%3A%7B%22choice%22%3A%22scheme%22%2C%22scheme%22%3A%22vnd.youtube%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%22%2C%22custom%22%3A%22%22%2C%22alternatives%22%3A%5B%5D%7D%2C%22not_installed%22%3A%7B%22choice%22%3A%22default%22%2C%22custom%22%3A%22%22%2C%22store%22%3A%22https%3A%5C%2F%5C%2Fitunes.apple.com%5C%2Fus%5C%2Fapp%5C%2Fyoutube%5C%2Fid544007664%22%7D%2C%22deeplink_method%22%3A%22aggressive%22%7D%2C%22tablet%22%3A%7B%22enabled%22%3A1%2C%22installed%22%3A%7B%22choice%22%3A%22scheme%22%2C%22scheme%22%3A%22vnd.youtube%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%22%2C%22custom%22%3A%22%22%2C%22alternatives%22%3A%5B%5D%7D%2C%22not_installed%22%3A%7B%22choice%22%3A%22default%22%2C%22custom%22%3A%22%22%2C%22store%22%3A%22https%3A%5C%2F%5C%2Fitunes.apple.com%5C%2Fus%5C%2Fapp%5C%2Fyoutube%5C%2Fid544007664%22%7D%2C%22deeplink_method%22%3A%22aggressive%22%7D%7D%2C%22android%22%3A%7B%22phone%22%3A%7B%22enabled%22%3A1%2C%22installed%22%3A%7B%22choice%22%3A%22scheme%22%2C%22scheme%22%3A%22intent%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%23Intent%3Bpackage%3Dcom.google.android.youtube%3Bscheme%3Dhttps%3BS.browser_fallback_url%3D%7Bnot_installed%7D%3Bend%22%2C%22custom%22%3A%22%22%2C%22alternatives%22%3A%5B%5D%7D%2C%22not_installed%22%3A%7B%22choice%22%3A%22default%22%2C%22custom%22%3A%22%22%2C%22store%22%3A%22https%3A%5C%2F%5C%2Fplay.google.com%5C%2Fstore%5C%2Fapps%5C%2Fdetails%3Fid%3Dcom.google.android.youtube%22%7D%2C%22force_chrome%22%3A0%2C%22deeplink_method%22%3A%22aggressive%22%7D%2C%22tablet%22%3A%7B%22enabled%22%3A1%2C%22installed%22%3A%7B%22choice%22%3A%22scheme%22%2C%22scheme%22%3A%22intent%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%23Intent%3Bpackage%3Dcom.google.android.youtube%3Bscheme%3Dhttps%3BS.browser_fallback_url%3D%7Bnot_installed%7D%3Bend%22%2C%22custom%22%3A%22%22%2C%22alternatives%22%3A%5B%5D%7D%2C%22not_installed%22%3A%7B%22choice%22%3A%22default%22%2C%22custom%22%3A%22%22%2C%22store%22%3A%22https%3A%5C%2F%5C%2Fplay.google.com%5C%2Fstore%5C%2Fapps%5C%2Fdetails%3Fid%3Dcom.google.android.youtube%22%7D%2C%22force_chrome%22%3A0%2C%22deeplink_method%22%3A%22aggressive%22%7D%7D%2C%22default_url%22%3A%22https%3A%5C%2F%5C%2Fyoutu.be%5C%2FoBg0slZQt1g%22%2C%22info%22%3A%7B%22title%22%3A%22JotURL+-+The+all-in-one+dream+suite+for+your+marketing+links%21%22%2C%22description%22%3A%22JotUrl%3A+Boost+your+inbound+marketing+results+and+conversions%2C+with+the+best+user+experience.+www.joturl.com%22%2C%22image%22%3A%22https%3A%5C%2F%5C%2Fi.ytimg.com%5C%2Fvi%5C%2FoBg0slZQt1g%5C%2Fmaxresdefault.jpg%22%2C%22ios_url%22%3A%22vnd.youtube%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%22%2C%22ios_store_url%22%3A%22https%3A%5C%2F%5C%2Fitunes.apple.com%5C%2Fus%5C%2Fapp%5C%2Fyoutube%5C%2Fid544007664%22%2C%22android_url%22%3A%22intent%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%23Intent%3Bpackage%3Dcom.google.android.youtube%3Bscheme%3Dhttps%3BS.browser_fallback_url%3D%7Bnot_installed%7D%3Bend%22%2C%22android_store_url%22%3A%22https%3A%5C%2F%5C%2Fplay.google.com%5C%2Fstore%5C%2Fapps%5C%2Fdetails%3Fid%3Dcom.google.android.youtube%22%2C%22info%22%3A%7B%22ios%22%3A%7B%22app_name%22%3A%22YouTube%22%2C%22app_store_id%22%3A%22544007664%22%2C%22url%22%3A%22vnd.youtube%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%22%7D%2C%22android%22%3A%7B%22app_name%22%3A%22YouTube%22%2C%22package%22%3A%22com.google.android.youtube%22%2C%22url%22%3A%22intent%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%23Intent%3Bpackage%3Dcom.google.android.youtube%3Bscheme%3Dhttps%3BS.browser_fallback_url%3D%7Bnot_installed%7D%3Bend%22%7D%7D%7D%2C%22detected%22%3A%5B%22ios%22%2C%22android%22%5D%2C%22og_title%22%3A%22JotURL+-+The+all-in-one+dream+suite+for+your+marketing+links%21%22%2C%22og_description%22%3A%22JotUrl%3A+Boost+your+inbound+marketing+results+and+conversions%2C+with+the+best+user+experience.+www.joturl.com%22%2C%22og_image%22%3A%22https%3A%5C%2F%5C%2Fi.ytimg.com%5C%2Fvi%5C%2FoBg0slZQt1g%5C%2Fmaxresdefault.jpg%22%7D

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_enabled=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/easydeeplinks/edit?id=b1df92ea475449e2af55e986537d74d7&format=plain

Query parameters

    id = b1df92ea475449e2af55e986537d74d7
format = plain

Post parameters

settings=%7B%22name%22%3A%22YouTube%22%2C%22category%22%3A%22social%22%2C%22ios%22%3A%7B%22phone%22%3A%7B%22enabled%22%3A1%2C%22installed%22%3A%7B%22choice%22%3A%22scheme%22%2C%22scheme%22%3A%22vnd.youtube%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%22%2C%22custom%22%3A%22%22%2C%22alternatives%22%3A%5B%5D%7D%2C%22not_installed%22%3A%7B%22choice%22%3A%22default%22%2C%22custom%22%3A%22%22%2C%22store%22%3A%22https%3A%5C%2F%5C%2Fitunes.apple.com%5C%2Fus%5C%2Fapp%5C%2Fyoutube%5C%2Fid544007664%22%7D%2C%22deeplink_method%22%3A%22aggressive%22%7D%2C%22tablet%22%3A%7B%22enabled%22%3A1%2C%22installed%22%3A%7B%22choice%22%3A%22scheme%22%2C%22scheme%22%3A%22vnd.youtube%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%22%2C%22custom%22%3A%22%22%2C%22alternatives%22%3A%5B%5D%7D%2C%22not_installed%22%3A%7B%22choice%22%3A%22default%22%2C%22custom%22%3A%22%22%2C%22store%22%3A%22https%3A%5C%2F%5C%2Fitunes.apple.com%5C%2Fus%5C%2Fapp%5C%2Fyoutube%5C%2Fid544007664%22%7D%2C%22deeplink_method%22%3A%22aggressive%22%7D%7D%2C%22android%22%3A%7B%22phone%22%3A%7B%22enabled%22%3A1%2C%22installed%22%3A%7B%22choice%22%3A%22scheme%22%2C%22scheme%22%3A%22intent%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%23Intent%3Bpackage%3Dcom.google.android.youtube%3Bscheme%3Dhttps%3BS.browser_fallback_url%3D%7Bnot_installed%7D%3Bend%22%2C%22custom%22%3A%22%22%2C%22alternatives%22%3A%5B%5D%7D%2C%22not_installed%22%3A%7B%22choice%22%3A%22default%22%2C%22custom%22%3A%22%22%2C%22store%22%3A%22https%3A%5C%2F%5C%2Fplay.google.com%5C%2Fstore%5C%2Fapps%5C%2Fdetails%3Fid%3Dcom.google.android.youtube%22%7D%2C%22force_chrome%22%3A0%2C%22deeplink_method%22%3A%22aggressive%22%7D%2C%22tablet%22%3A%7B%22enabled%22%3A1%2C%22installed%22%3A%7B%22choice%22%3A%22scheme%22%2C%22scheme%22%3A%22intent%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%23Intent%3Bpackage%3Dcom.google.android.youtube%3Bscheme%3Dhttps%3BS.browser_fallback_url%3D%7Bnot_installed%7D%3Bend%22%2C%22custom%22%3A%22%22%2C%22alternatives%22%3A%5B%5D%7D%2C%22not_installed%22%3A%7B%22choice%22%3A%22default%22%2C%22custom%22%3A%22%22%2C%22store%22%3A%22https%3A%5C%2F%5C%2Fplay.google.com%5C%2Fstore%5C%2Fapps%5C%2Fdetails%3Fid%3Dcom.google.android.youtube%22%7D%2C%22force_chrome%22%3A0%2C%22deeplink_method%22%3A%22aggressive%22%7D%7D%2C%22default_url%22%3A%22https%3A%5C%2F%5C%2Fyoutu.be%5C%2FoBg0slZQt1g%22%2C%22info%22%3A%7B%22title%22%3A%22JotURL+-+The+all-in-one+dream+suite+for+your+marketing+links%21%22%2C%22description%22%3A%22JotUrl%3A+Boost+your+inbound+marketing+results+and+conversions%2C+with+the+best+user+experience.+www.joturl.com%22%2C%22image%22%3A%22https%3A%5C%2F%5C%2Fi.ytimg.com%5C%2Fvi%5C%2FoBg0slZQt1g%5C%2Fmaxresdefault.jpg%22%2C%22ios_url%22%3A%22vnd.youtube%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%22%2C%22ios_store_url%22%3A%22https%3A%5C%2F%5C%2Fitunes.apple.com%5C%2Fus%5C%2Fapp%5C%2Fyoutube%5C%2Fid544007664%22%2C%22android_url%22%3A%22intent%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%23Intent%3Bpackage%3Dcom.google.android.youtube%3Bscheme%3Dhttps%3BS.browser_fallback_url%3D%7Bnot_installed%7D%3Bend%22%2C%22android_store_url%22%3A%22https%3A%5C%2F%5C%2Fplay.google.com%5C%2Fstore%5C%2Fapps%5C%2Fdetails%3Fid%3Dcom.google.android.youtube%22%2C%22info%22%3A%7B%22ios%22%3A%7B%22app_name%22%3A%22YouTube%22%2C%22app_store_id%22%3A%22544007664%22%2C%22url%22%3A%22vnd.youtube%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%22%7D%2C%22android%22%3A%7B%22app_name%22%3A%22YouTube%22%2C%22package%22%3A%22com.google.android.youtube%22%2C%22url%22%3A%22intent%3A%5C%2F%5C%2Fwww.youtube.com%5C%2Fwatch%3Fv%3DoBg0slZQt1g%26feature%3Dyoutu.be%23Intent%3Bpackage%3Dcom.google.android.youtube%3Bscheme%3Dhttps%3BS.browser_fallback_url%3D%7Bnot_installed%7D%3Bend%22%7D%7D%7D%2C%22detected%22%3A%5B%22ios%22%2C%22android%22%5D%2C%22og_title%22%3A%22JotURL+-+The+all-in-one+dream+suite+for+your+marketing+links%21%22%2C%22og_description%22%3A%22JotUrl%3A+Boost+your+inbound+marketing+results+and+conversions%2C+with+the+best+user+experience.+www.joturl.com%22%2C%22og_image%22%3A%22https%3A%5C%2F%5C%2Fi.ytimg.com%5C%2Fvi%5C%2FoBg0slZQt1g%5C%2Fmaxresdefault.jpg%22%7D

Response

1
Required parameters
parameterdescription
idIDtracking link ID for which you want to edit the easy deep link configuration
settingsJSONstringified JSON of the easy deep link configuration, see i1/urls/easydeeplinks/info for details
Return values
parameterdescription
enabled1 if the easy deep link option has been successfully enabled, 0 otherwise

access: [READ]

Get an easy deep link settings for a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/easydeeplinks/info?id=eff849e2b3418c43d99a7b83d9cb14e9

Query parameters

id = eff849e2b3418c43d99a7b83d9cb14e9

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "name": "YouTube",
    "category": "social",
    "ios": {
      "phone": {
        "enabled": 1,
        "installed": {
          "choice": "scheme",
          "scheme": "vnd.youtube:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&feature=youtu.be",
          "custom": "",
          "alternatives": []
        },
        "not_installed": {
          "choice": "default",
          "custom": "",
          "store": "https:\/\/itunes.apple.com\/us\/app\/youtube\/id544007664"
        }
      },
      "tablet": {
        "enabled": 1,
        "installed": {
          "choice": "scheme",
          "scheme": "vnd.youtube:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&feature=youtu.be",
          "custom": "",
          "alternatives": []
        },
        "not_installed": {
          "choice": "default",
          "custom": "",
          "store": "https:\/\/itunes.apple.com\/us\/app\/youtube\/id544007664"
        }
      }
    },
    "android": {
      "phone": {
        "enabled": 1,
        "installed": {
          "choice": "scheme",
          "scheme": "intent:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end",
          "custom": "",
          "alternatives": []
        },
        "not_installed": {
          "choice": "default",
          "custom": "",
          "store": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.youtube"
        }
      },
      "tablet": {
        "enabled": 1,
        "installed": {
          "choice": "scheme",
          "scheme": "intent:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end",
          "custom": "",
          "alternatives": []
        },
        "not_installed": {
          "choice": "default",
          "custom": "",
          "store": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.youtube"
        }
      }
    },
    "default_url": "https:\/\/youtu.be\/oBg0slZQt1g",
    "info": {
      "title": "JotURL - The all-in-one dream suite for your marketing links!",
      "description": "JotUrl: Boost your inbound marketing results and conversions, with the best user experience. www.joturl.com",
      "image": "https:\/\/i.ytimg.com\/vi\/oBg0slZQt1g\/maxresdefault.jpg",
      "ios_url": "vnd.youtube:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&feature=youtu.be",
      "ios_store_url": "https:\/\/itunes.apple.com\/us\/app\/youtube\/id544007664",
      "android_url": "intent:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end",
      "android_store_url": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.youtube",
      "info": {
        "ios": {
          "app_name": "YouTube",
          "app_store_id": "544007664",
          "url": "vnd.youtube:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&feature=youtu.be"
        },
        "android": {
          "app_name": "YouTube",
          "package": "com.google.android.youtube",
          "url": "intent:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end"
        }
      }
    },
    "detected": [
      "ios",
      "android"
    ],
    "autodetect": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/easydeeplinks/info?id=eff849e2b3418c43d99a7b83d9cb14e9&format=xml

Query parameters

    id = eff849e2b3418c43d99a7b83d9cb14e9
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <name>YouTube</name>  
    <category>social</category>  
    <ios>
      <phone>
        <enabled>1</enabled>  
        <installed>
          <choice>scheme</choice>  
          <scheme><[CDATA[vnd.youtube://www.youtube.com/watch?v=oBg0slZQt1g&amp;feature=youtu.be]]></scheme>  
          <custom></custom>  
          <alternatives>

          </alternatives>  
        </installed>  
        <not_installed>
          <choice>default</choice>  
          <custom></custom>  
          <store>https://itunes.apple.com/us/app/youtube/id544007664</store>  
        </not_installed>  
      </phone>  
      <tablet>
        <enabled>1</enabled>  
        <installed>
          <choice>scheme</choice>  
          <scheme><[CDATA[vnd.youtube://www.youtube.com/watch?v=oBg0slZQt1g&amp;feature=youtu.be]]></scheme>  
          <custom></custom>  
          <alternatives>

          </alternatives>  
        </installed>  
        <not_installed>
          <choice>default</choice>  
          <custom></custom>  
          <store>https://itunes.apple.com/us/app/youtube/id544007664</store>  
        </not_installed>  
      </tablet>  
    </ios>  
    <android>
      <phone>
        <enabled>1</enabled>  
        <installed>
          <choice>scheme</choice>  
          <scheme><[CDATA[intent://www.youtube.com/watch?v=oBg0slZQt1g&amp;feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end]]></scheme>  
          <custom></custom>  
          <alternatives>

          </alternatives>  
        </installed>  
        <not_installed>
          <choice>default</choice>  
          <custom></custom>  
          <store>https://play.google.com/store/apps/details?id=com.google.android.youtube</store>  
        </not_installed>  
      </phone>  
      <tablet>
        <enabled>1</enabled>  
        <installed>
          <choice>scheme</choice>  
          <scheme><[CDATA[intent://www.youtube.com/watch?v=oBg0slZQt1g&amp;feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end]]></scheme>  
          <custom></custom>  
          <alternatives>

          </alternatives>  
        </installed>  
        <not_installed>
          <choice>default</choice>  
          <custom></custom>  
          <store>https://play.google.com/store/apps/details?id=com.google.android.youtube</store>  
        </not_installed>  
      </tablet>  
    </android>  
    <default_url>https://youtu.be/oBg0slZQt1g</default_url>  
    <info>
      <title>JotURL - The all-in-one dream suite for your marketing links!</title>  
      <description>JotUrl: Boost your inbound marketing results and conversions, with the best user experience. www.joturl.com</description>  
      <image>https://i.ytimg.com/vi/oBg0slZQt1g/maxresdefault.jpg</image>  
      <ios_url><[CDATA[vnd.youtube://www.youtube.com/watch?v=oBg0slZQt1g&amp;feature=youtu.be]]></ios_url>  
      <ios_store_url>https://itunes.apple.com/us/app/youtube/id544007664</ios_store_url>  
      <android_url><[CDATA[intent://www.youtube.com/watch?v=oBg0slZQt1g&amp;feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end]]></android_url>  
      <android_store_url>https://play.google.com/store/apps/details?id=com.google.android.youtube</android_store_url>  
      <info>
        <ios>
          <app_name>YouTube</app_name>  
          <app_store_id>544007664</app_store_id>  
          <url><[CDATA[vnd.youtube://www.youtube.com/watch?v=oBg0slZQt1g&amp;feature=youtu.be]]></url>  
        </ios>  
        <android>
          <app_name>YouTube</app_name>  
          <package>com.google.android.youtube</package>  
          <url><[CDATA[intent://www.youtube.com/watch?v=oBg0slZQt1g&amp;feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end]]></url>  
        </android>  
      </info>  
    </info>  
    <detected>
      <i0>ios</i0>  
      <i1>android</i1>  
    </detected>  
    <autodetect>1</autodetect>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/easydeeplinks/info?id=eff849e2b3418c43d99a7b83d9cb14e9&format=txt

Query parameters

    id = eff849e2b3418c43d99a7b83d9cb14e9
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_name=YouTube
result_category=social
result_ios_phone_enabled=1
result_ios_phone_installed_choice=scheme
result_ios_phone_installed_scheme=vnd.youtube://www.youtube.com/watch?v=oBg0slZQt1g&amp;feature=youtu.be
result_ios_phone_installed_custom=
result_ios_phone_installed_alternatives=
result_ios_phone_not_installed_choice=default
result_ios_phone_not_installed_custom=
result_ios_phone_not_installed_store=https://itunes.apple.com/us/app/youtube/id544007664
result_ios_tablet_enabled=1
result_ios_tablet_installed_choice=scheme
result_ios_tablet_installed_scheme=vnd.youtube://www.youtube.com/watch?v=oBg0slZQt1g&amp;feature=youtu.be
result_ios_tablet_installed_custom=
result_ios_tablet_installed_alternatives=
result_ios_tablet_not_installed_choice=default
result_ios_tablet_not_installed_custom=
result_ios_tablet_not_installed_store=https://itunes.apple.com/us/app/youtube/id544007664
result_android_phone_enabled=1
result_android_phone_installed_choice=scheme
result_android_phone_installed_scheme=intent://www.youtube.com/watch?v=oBg0slZQt1g&amp;feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end
result_android_phone_installed_custom=
result_android_phone_installed_alternatives=
result_android_phone_not_installed_choice=default
result_android_phone_not_installed_custom=
result_android_phone_not_installed_store=https://play.google.com/store/apps/details?id=com.google.android.youtube
result_android_tablet_enabled=1
result_android_tablet_installed_choice=scheme
result_android_tablet_installed_scheme=intent://www.youtube.com/watch?v=oBg0slZQt1g&amp;feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end
result_android_tablet_installed_custom=
result_android_tablet_installed_alternatives=
result_android_tablet_not_installed_choice=default
result_android_tablet_not_installed_custom=
result_android_tablet_not_installed_store=https://play.google.com/store/apps/details?id=com.google.android.youtube
result_default_url=https://youtu.be/oBg0slZQt1g
result_info_title=JotURL - The all-in-one dream suite for your marketing links!
result_info_description=JotUrl: Boost your inbound marketing results and conversions, with the best user experience. www.joturl.com
result_info_image=https://i.ytimg.com/vi/oBg0slZQt1g/maxresdefault.jpg
result_info_ios_url=vnd.youtube://www.youtube.com/watch?v=oBg0slZQt1g&amp;feature=youtu.be
result_info_ios_store_url=https://itunes.apple.com/us/app/youtube/id544007664
result_info_android_url=intent://www.youtube.com/watch?v=oBg0slZQt1g&amp;feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end
result_info_android_store_url=https://play.google.com/store/apps/details?id=com.google.android.youtube
result_info_info_ios_app_name=YouTube
result_info_info_ios_app_store_id=544007664
result_info_info_ios_url=vnd.youtube://www.youtube.com/watch?v=oBg0slZQt1g&amp;feature=youtu.be
result_info_info_android_app_name=YouTube
result_info_info_android_package=com.google.android.youtube
result_info_info_android_url=intent://www.youtube.com/watch?v=oBg0slZQt1g&amp;feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end
result_detected_0=ios
result_detected_1=android
result_autodetect=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/easydeeplinks/info?id=eff849e2b3418c43d99a7b83d9cb14e9&format=plain

Query parameters

    id = eff849e2b3418c43d99a7b83d9cb14e9
format = plain

Response

YouTube
social
1
scheme
vnd.youtube://www.youtube.com/watch?v=oBg0slZQt1g&amp;feature=youtu.be


default

https://itunes.apple.com/us/app/youtube/id544007664
1
scheme
vnd.youtube://www.youtube.com/watch?v=oBg0slZQt1g&amp;feature=youtu.be


default

https://itunes.apple.com/us/app/youtube/id544007664
1
scheme
intent://www.youtube.com/watch?v=oBg0slZQt1g&amp;feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end


default

https://play.google.com/store/apps/details?id=com.google.android.youtube
1
scheme
intent://www.youtube.com/watch?v=oBg0slZQt1g&amp;feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end


default

https://play.google.com/store/apps/details?id=com.google.android.youtube
https://youtu.be/oBg0slZQt1g
JotURL - The all-in-one dream suite for your marketing links!
JotUrl: Boost your inbound marketing results and conversions, with the best user experience. www.joturl.com
https://i.ytimg.com/vi/oBg0slZQt1g/maxresdefault.jpg
vnd.youtube://www.youtube.com/watch?v=oBg0slZQt1g&amp;feature=youtu.be
https://itunes.apple.com/us/app/youtube/id544007664
intent://www.youtube.com/watch?v=oBg0slZQt1g&amp;feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end
https://play.google.com/store/apps/details?id=com.google.android.youtube
YouTube
544007664
vnd.youtube://www.youtube.com/watch?v=oBg0slZQt1g&amp;feature=youtu.be
YouTube
com.google.android.youtube
intent://www.youtube.com/watch?v=oBg0slZQt1g&amp;feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end
ios
android
1

Example 5 (json)

Request

https://joturl.com/a/i1/urls/easydeeplinks/info?id=71dbcd1fc67be9c69db33013fce3c8f4

Query parameters

id = 71dbcd1fc67be9c69db33013fce3c8f4

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "settings": "{\"name\":\"YouTube\",\"category\":\"social\",\"ios\":{\"phone\":{\"enabled\":1,\"installed\":{\"choice\":\"scheme\",\"scheme\":\"vnd.youtube:\\\/\\\/www.youtube.com\\\/watch?v=oBg0slZQt1g&feature=youtu.be\",\"custom\":\"\",\"alternatives\":[]},\"not_installed\":{\"choice\":\"default\",\"custom\":\"\",\"store\":\"https:\\\/\\\/itunes.apple.com\\\/us\\\/app\\\/youtube\\\/id544007664\"},\"deeplink_method\":\"aggressive\"},\"tablet\":{\"enabled\":1,\"installed\":{\"choice\":\"scheme\",\"scheme\":\"vnd.youtube:\\\/\\\/www.youtube.com\\\/watch?v=oBg0slZQt1g&feature=youtu.be\",\"custom\":\"\",\"alternatives\":[]},\"not_installed\":{\"choice\":\"default\",\"custom\":\"\",\"store\":\"https:\\\/\\\/itunes.apple.com\\\/us\\\/app\\\/youtube\\\/id544007664\"},\"deeplink_method\":\"aggressive\"}},\"android\":{\"phone\":{\"enabled\":1,\"installed\":{\"choice\":\"scheme\",\"scheme\":\"intent:\\\/\\\/www.youtube.com\\\/watch?v=oBg0slZQt1g&feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end\",\"custom\":\"\",\"alternatives\":[]},\"not_installed\":{\"choice\":\"default\",\"custom\":\"\",\"store\":\"https:\\\/\\\/play.google.com\\\/store\\\/apps\\\/details?id=com.google.android.youtube\"},\"force_chrome\":0,\"deeplink_method\":\"aggressive\"},\"tablet\":{\"enabled\":1,\"installed\":{\"choice\":\"scheme\",\"scheme\":\"intent:\\\/\\\/www.youtube.com\\\/watch?v=oBg0slZQt1g&feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end\",\"custom\":\"\",\"alternatives\":[]},\"not_installed\":{\"choice\":\"default\",\"custom\":\"\",\"store\":\"https:\\\/\\\/play.google.com\\\/store\\\/apps\\\/details?id=com.google.android.youtube\"},\"force_chrome\":0,\"deeplink_method\":\"aggressive\"}},\"default_url\":\"https:\\\/\\\/youtu.be\\\/oBg0slZQt1g\",\"info\":{\"title\":\"JotURL - The all-in-one dream suite for your marketing links!\",\"description\":\"JotUrl: Boost your inbound marketing results and conversions, with the best user experience. www.joturl.com\",\"image\":\"https:\\\/\\\/i.ytimg.com\\\/vi\\\/oBg0slZQt1g\\\/maxresdefault.jpg\",\"ios_url\":\"vnd.youtube:\\\/\\\/www.youtube.com\\\/watch?v=oBg0slZQt1g&feature=youtu.be\",\"ios_store_url\":\"https:\\\/\\\/itunes.apple.com\\\/us\\\/app\\\/youtube\\\/id544007664\",\"android_url\":\"intent:\\\/\\\/www.youtube.com\\\/watch?v=oBg0slZQt1g&feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end\",\"android_store_url\":\"https:\\\/\\\/play.google.com\\\/store\\\/apps\\\/details?id=com.google.android.youtube\",\"info\":{\"ios\":{\"app_name\":\"YouTube\",\"app_store_id\":\"544007664\",\"url\":\"vnd.youtube:\\\/\\\/www.youtube.com\\\/watch?v=oBg0slZQt1g&feature=youtu.be\"},\"android\":{\"app_name\":\"YouTube\",\"package\":\"com.google.android.youtube\",\"url\":\"intent:\\\/\\\/www.youtube.com\\\/watch?v=oBg0slZQt1g&feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end\"}}},\"detected\":[\"ios\",\"android\"],\"og_title\":\"JotURL - The all-in-one dream suite for your marketing links!\",\"og_description\":\"JotUrl: Boost your inbound marketing results and conversions, with the best user experience. www.joturl.com\",\"og_image\":\"https:\\\/\\\/i.ytimg.com\\\/vi\\\/oBg0slZQt1g\\\/maxresdefault.jpg\"}",
    "autodetect": 0
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/urls/easydeeplinks/info?id=71dbcd1fc67be9c69db33013fce3c8f4&format=xml

Query parameters

    id = 71dbcd1fc67be9c69db33013fce3c8f4
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <settings><[CDATA[{"name":"YouTube","category":"social","ios":{"phone":{"enabled":1,"installed":{"choice":"scheme","scheme":"vnd.youtube:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&amp;feature=youtu.be","custom":"","alternatives":[]},"not_installed":{"choice":"default","custom":"","store":"https:\/\/itunes.apple.com\/us\/app\/youtube\/id544007664"},"deeplink_method":"aggressive"},"tablet":{"enabled":1,"installed":{"choice":"scheme","scheme":"vnd.youtube:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&amp;feature=youtu.be","custom":"","alternatives":[]},"not_installed":{"choice":"default","custom":"","store":"https:\/\/itunes.apple.com\/us\/app\/youtube\/id544007664"},"deeplink_method":"aggressive"}},"android":{"phone":{"enabled":1,"installed":{"choice":"scheme","scheme":"intent:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&amp;feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end","custom":"","alternatives":[]},"not_installed":{"choice":"default","custom":"","store":"https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.youtube"},"force_chrome":0,"deeplink_method":"aggressive"},"tablet":{"enabled":1,"installed":{"choice":"scheme","scheme":"intent:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&amp;feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end","custom":"","alternatives":[]},"not_installed":{"choice":"default","custom":"","store":"https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.youtube"},"force_chrome":0,"deeplink_method":"aggressive"}},"default_url":"https:\/\/youtu.be\/oBg0slZQt1g","info":{"title":"JotURL - The all-in-one dream suite for your marketing links!","description":"JotUrl: Boost your inbound marketing results and conversions, with the best user experience. www.joturl.com","image":"https:\/\/i.ytimg.com\/vi\/oBg0slZQt1g\/maxresdefault.jpg","ios_url":"vnd.youtube:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&amp;feature=youtu.be","ios_store_url":"https:\/\/itunes.apple.com\/us\/app\/youtube\/id544007664","android_url":"intent:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&amp;feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end","android_store_url":"https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.youtube","info":{"ios":{"app_name":"YouTube","app_store_id":"544007664","url":"vnd.youtube:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&amp;feature=youtu.be"},"android":{"app_name":"YouTube","package":"com.google.android.youtube","url":"intent:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&amp;feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end"}}},"detected":["ios","android"],"og_title":"JotURL - The all-in-one dream suite for your marketing links!","og_description":"JotUrl: Boost your inbound marketing results and conversions, with the best user experience. www.joturl.com","og_image":"https:\/\/i.ytimg.com\/vi\/oBg0slZQt1g\/maxresdefault.jpg"}]]></settings>  
    <autodetect>0</autodetect>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/urls/easydeeplinks/info?id=71dbcd1fc67be9c69db33013fce3c8f4&format=txt

Query parameters

    id = 71dbcd1fc67be9c69db33013fce3c8f4
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_settings={"name":"YouTube","category":"social","ios":{"phone":{"enabled":1,"installed":{"choice":"scheme","scheme":"vnd.youtube:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&amp;feature=youtu.be","custom":"","alternatives":[]},"not_installed":{"choice":"default","custom":"","store":"https:\/\/itunes.apple.com\/us\/app\/youtube\/id544007664"},"deeplink_method":"aggressive"},"tablet":{"enabled":1,"installed":{"choice":"scheme","scheme":"vnd.youtube:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&amp;feature=youtu.be","custom":"","alternatives":[]},"not_installed":{"choice":"default","custom":"","store":"https:\/\/itunes.apple.com\/us\/app\/youtube\/id544007664"},"deeplink_method":"aggressive"}},"android":{"phone":{"enabled":1,"installed":{"choice":"scheme","scheme":"intent:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&amp;feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end","custom":"","alternatives":[]},"not_installed":{"choice":"default","custom":"","store":"https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.youtube"},"force_chrome":0,"deeplink_method":"aggressive"},"tablet":{"enabled":1,"installed":{"choice":"scheme","scheme":"intent:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&amp;feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end","custom":"","alternatives":[]},"not_installed":{"choice":"default","custom":"","store":"https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.youtube"},"force_chrome":0,"deeplink_method":"aggressive"}},"default_url":"https:\/\/youtu.be\/oBg0slZQt1g","info":{"title":"JotURL - The all-in-one dream suite for your marketing links!","description":"JotUrl: Boost your inbound marketing results and conversions, with the best user experience. www.joturl.com","image":"https:\/\/i.ytimg.com\/vi\/oBg0slZQt1g\/maxresdefault.jpg","ios_url":"vnd.youtube:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&amp;feature=youtu.be","ios_store_url":"https:\/\/itunes.apple.com\/us\/app\/youtube\/id544007664","android_url":"intent:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&amp;feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end","android_store_url":"https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.youtube","info":{"ios":{"app_name":"YouTube","app_store_id":"544007664","url":"vnd.youtube:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&amp;feature=youtu.be"},"android":{"app_name":"YouTube","package":"com.google.android.youtube","url":"intent:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&amp;feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end"}}},"detected":["ios","android"],"og_title":"JotURL - The all-in-one dream suite for your marketing links!","og_description":"JotUrl: Boost your inbound marketing results and conversions, with the best user experience. www.joturl.com","og_image":"https:\/\/i.ytimg.com\/vi\/oBg0slZQt1g\/maxresdefault.jpg"}
result_autodetect=0

Example 8 (plain)

Request

https://joturl.com/a/i1/urls/easydeeplinks/info?id=71dbcd1fc67be9c69db33013fce3c8f4&format=plain

Query parameters

    id = 71dbcd1fc67be9c69db33013fce3c8f4
format = plain

Response

{"name":"YouTube","category":"social","ios":{"phone":{"enabled":1,"installed":{"choice":"scheme","scheme":"vnd.youtube:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&amp;feature=youtu.be","custom":"","alternatives":[]},"not_installed":{"choice":"default","custom":"","store":"https:\/\/itunes.apple.com\/us\/app\/youtube\/id544007664"},"deeplink_method":"aggressive"},"tablet":{"enabled":1,"installed":{"choice":"scheme","scheme":"vnd.youtube:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&amp;feature=youtu.be","custom":"","alternatives":[]},"not_installed":{"choice":"default","custom":"","store":"https:\/\/itunes.apple.com\/us\/app\/youtube\/id544007664"},"deeplink_method":"aggressive"}},"android":{"phone":{"enabled":1,"installed":{"choice":"scheme","scheme":"intent:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&amp;feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end","custom":"","alternatives":[]},"not_installed":{"choice":"default","custom":"","store":"https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.youtube"},"force_chrome":0,"deeplink_method":"aggressive"},"tablet":{"enabled":1,"installed":{"choice":"scheme","scheme":"intent:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&amp;feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end","custom":"","alternatives":[]},"not_installed":{"choice":"default","custom":"","store":"https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.youtube"},"force_chrome":0,"deeplink_method":"aggressive"}},"default_url":"https:\/\/youtu.be\/oBg0slZQt1g","info":{"title":"JotURL - The all-in-one dream suite for your marketing links!","description":"JotUrl: Boost your inbound marketing results and conversions, with the best user experience. www.joturl.com","image":"https:\/\/i.ytimg.com\/vi\/oBg0slZQt1g\/maxresdefault.jpg","ios_url":"vnd.youtube:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&amp;feature=youtu.be","ios_store_url":"https:\/\/itunes.apple.com\/us\/app\/youtube\/id544007664","android_url":"intent:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&amp;feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end","android_store_url":"https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.youtube","info":{"ios":{"app_name":"YouTube","app_store_id":"544007664","url":"vnd.youtube:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&amp;feature=youtu.be"},"android":{"app_name":"YouTube","package":"com.google.android.youtube","url":"intent:\/\/www.youtube.com\/watch?v=oBg0slZQt1g&amp;feature=youtu.be#Intent;package=com.google.android.youtube;scheme=https;S.browser_fallback_url={not_installed};end"}}},"detected":["ios","android"],"og_title":"JotURL - The all-in-one dream suite for your marketing links!","og_description":"JotUrl: Boost your inbound marketing results and conversions, with the best user experience. www.joturl.com","og_image":"https:\/\/i.ytimg.com\/vi\/oBg0slZQt1g\/maxresdefault.jpg"}
0
Required parameters
parameterdescription
idIDtracking link ID for which you want to extract the easy deep link configuration
Return values
parameterdescription
android[OPTIONAL] array containing the easy deep link configuration for Android, returned only if autodetect = 1
autodetect1 if the configuration was automatically detected, 0 if it was taken from a previously set configuration
category[OPTIONAL] category of the easy deep link provider, returned only if autodetect = 1, supported categories: affiliation, business, entertainment, lifestyle, music, other, shopping, social, travel, unknown, website
default_url[OPTIONAL] default URL for the easy deepl ink configuration, returned only if autodetect = 1
detected[OPTIONAL] returned only if autodetect = 1, array containing the extracted information, it can contain the values ios and android depending on whether our system was able to extract the deep link information for that specific operating system, it contains only one of the above values in case it is not possible to extract the information for the deep link for one of the operating systems, it can be empty in case it is not possible to extract the information for the deep link
info[OPTIONAL] Open Graph information extracted from default_url and raw deep link information, returned only if autodetect = 1
ios[OPTIONAL] array containing the easy deep link configuration for iOS, returned only if autodetect = 1
name[OPTIONAL] name of the easy deep link provider, returned only if autodetect = 1, supported names: Adidas, AliExpress, Amazon, Apartments.com, Apple Maps, Apple Music, Apple Podcast, Best Buy, BlueSky, Booking.com, BrandCycle, Discord, eBay, Epic Games Store, Etsy, Expedia, Facebook, Flipkart, Google Docs, Google Maps, Google Sheets, Google Slides, Howl, HSN, iFood, IKEA, Instagram, Kaufland, Kickstarter, Kohl's, LINE, LinkedIn, LTK, Macy's, MagicLinks, Mavely, Medium, Mercado Livre, Messenger, Microsoft Excel, Microsoft PowerPoint, Microsoft Word, Netflix, Nordstrom, OnlyFans, Otto, Pinterest, Product Hunt, Quora, QVC, Reddit, Refersion, SHEIN, Signal, Skype, Snapchat, Spotify, Steam, Target, Telegram, Temu, The Home Depot, TikTok, TripAdvisor, Trulia, Twitch TV, Unknown, Viber, Vimeo, Walmart, WhatsApp, X, YouTube, Zendesk Support, Zillow, Zulily
settings[OPTIONAL] returned only if autodetect = 0, stringified JSON of the easy deep link configuration, it contains the same fields returned when autodetect = 1 except autodetect plus the fields: og_title, og_description, og_image which are the corresponding custom Open Graph fields

NOTES: Both android and ios arrays have the following structure:

{
    "phone": (DEEPLINK_INFO),
    "tablet": (DEEPLINK_INFO)
}
Where (DEEPLINK_INFO) is:
{
    "enabled":(ENABLED),
    "installed":{
        "choice":"(INSTALLED_CHOICE)",
        "scheme":"(URI SCHEME)",
        "custom":"(CUSTOM URI SCHEME WHEN APP INSTALLED)",
        "alternatives":(ALTERNATIVES WHEN APP INSTALLED)
    },
    "not_installed":{
        "choice":"(NOT_INSTALLED_CHOICE)",
        "custom":"(CUSTOM URI SCHEME WHEN APP NOT INSTALLED)",
        "store":"(STORE URL)"
    },
    "force_chrome":(FORCE_CHROME),
    "force_redirect":(FORCE_REDIRECT),
    "deeplink_method":(DEEPLINK_METHOD)
}
With 

(ENABLED):
- 1: to enabled the specific configuration (phone or tablet)
- 0: to disable the specific configuration, in this case the default URL will be used to redirect the user

(INSTALLED_CHOICE):
- scheme: use the (URI SCHEME) for deep linking
- custom: use the (CUSTOM URI SCHEME WHEN APP INSTALLED)  for deep linking

(ALTERNATIVES WHEN APP INSTALLED): array of alternatives for the field (CUSTOM URI SCHEME WHEN APP INSTALLED), it can be an empty array or contain elements like this:
{
    "type": "[unique ID]",
    "url": "[alternative custom URI scheme]"
} 
(NOT_INSTALLED_CHOICE):
- default: use the default_url to redirect the user when the app is not installed
- store: use the (STORE URL) to redirect the user when the app is not installed
- custom: use the (CUSTOM URI SCHEME WHEN APP NOT INSTALLED) to redirect the user when the app is not installed

(FORCE_CHROME), may not be present and available only for Android (in all other cases it is ignored):  
- 1: to try to open Chrome before deep linking (useful in all those apps that open links in the webview, e.g., Facebook)
- 0: to not try to open Chrome

(FORCE_REDIRECT), may not be present and available only for Android (in all other cases it is ignored), this flag is only used 
 when `(NOT_INSTALLED_CHOICE) = default`, `(FORCE_CHROME) = 0` and our engine detects a webview (in-app browser, e.g., the Facebook internal browser), 
 in this case and when the deep link fails:
- 1: force a redirect to default_url instead of opening the Android Play Store
- 0: open the Android Play Store

(DEEPLINK_METHOD), only available when autodetect = 0:
- aggressive: try to open the app anyway, although this may cause errors (recommended)
- conservative: our engine tries to open the app only if our engine can determine if the app is installed

access: [READ]

Get all supported apps for easy deep link grouped by category.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/easydeeplinks/list

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "shopping": [
      "Adidas",
      "AliExpress",
      "Amazon",
      "Best Buy",
      "eBay",
      "Etsy",
      "Flipkart",
      "HSN",
      "IKEA",
      "Kaufland",
      "Kohl's",
      "LTK",
      "Macy's",
      "Mercado Livre",
      "Nordstrom",
      "Otto",
      "QVC",
      "SHEIN",
      "Target",
      "Temu",
      "The Home Depot",
      "Walmart",
      "Zulily"
    ],
    "lifestyle": [
      "Apartments.com",
      "iFood",
      "Trulia",
      "Zillow"
    ],
    "travel": [
      "Apple Maps",
      "Booking.com",
      "Expedia",
      "Google Maps",
      "TripAdvisor"
    ],
    "music": [
      "Apple Music",
      "Spotify"
    ],
    "other": [
      "Apple Podcast",
      "Zendesk Support"
    ],
    "social": [
      "BlueSky",
      "Discord",
      "Facebook",
      "Instagram",
      "LINE",
      "LinkedIn",
      "Messenger",
      "Pinterest",
      "Product Hunt",
      "Reddit",
      "Signal",
      "Skype",
      "Snapchat",
      "Telegram",
      "TikTok",
      "Viber",
      "Vimeo",
      "X",
      "YouTube"
    ],
    "affiliation": [
      "BrandCycle",
      "Howl",
      "MagicLinks",
      "Mavely",
      "Refersion"
    ],
    "entertainment": [
      "Epic Games Store",
      "Netflix",
      "OnlyFans",
      "Steam",
      "Twitch TV"
    ],
    "business": [
      "Google Docs",
      "Google Sheets",
      "Google Slides",
      "Microsoft Excel",
      "Microsoft PowerPoint",
      "Microsoft Word"
    ],
    "website": [
      "Kickstarter",
      "Medium",
      "Quora"
    ],
    "unknown": [
      "Unknown"
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/easydeeplinks/list?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <shopping>
      <i0>Adidas</i0>  
      <i1>AliExpress</i1>  
      <i2>Amazon</i2>  
      <i3>Best Buy</i3>  
      <i4>eBay</i4>  
      <i5>Etsy</i5>  
      <i6>Flipkart</i6>  
      <i7>HSN</i7>  
      <i8>IKEA</i8>  
      <i9>Kaufland</i9>  
      <i10>Kohl's</i10>  
      <i11>LTK</i11>  
      <i12>Macy's</i12>  
      <i13>Mercado Livre</i13>  
      <i14>Nordstrom</i14>  
      <i15>Otto</i15>  
      <i16>QVC</i16>  
      <i17>SHEIN</i17>  
      <i18>Target</i18>  
      <i19>Temu</i19>  
      <i20>The Home Depot</i20>  
      <i21>Walmart</i21>  
      <i22>Zulily</i22>  
    </shopping>  
    <lifestyle>
      <i0>Apartments.com</i0>  
      <i1>iFood</i1>  
      <i2>Trulia</i2>  
      <i3>Zillow</i3>  
    </lifestyle>  
    <travel>
      <i0>Apple Maps</i0>  
      <i1>Booking.com</i1>  
      <i2>Expedia</i2>  
      <i3>Google Maps</i3>  
      <i4>TripAdvisor</i4>  
    </travel>  
    <music>
      <i0>Apple Music</i0>  
      <i1>Spotify</i1>  
    </music>  
    <other>
      <i0>Apple Podcast</i0>  
      <i1>Zendesk Support</i1>  
    </other>  
    <social>
      <i0>BlueSky</i0>  
      <i1>Discord</i1>  
      <i2>Facebook</i2>  
      <i3>Instagram</i3>  
      <i4>LINE</i4>  
      <i5>LinkedIn</i5>  
      <i6>Messenger</i6>  
      <i7>Pinterest</i7>  
      <i8>Product Hunt</i8>  
      <i9>Reddit</i9>  
      <i10>Signal</i10>  
      <i11>Skype</i11>  
      <i12>Snapchat</i12>  
      <i13>Telegram</i13>  
      <i14>TikTok</i14>  
      <i15>Viber</i15>  
      <i16>Vimeo</i16>  
      <i17>X</i17>  
      <i18>YouTube</i18>  
    </social>  
    <affiliation>
      <i0>BrandCycle</i0>  
      <i1>Howl</i1>  
      <i2>MagicLinks</i2>  
      <i3>Mavely</i3>  
      <i4>Refersion</i4>  
    </affiliation>  
    <entertainment>
      <i0>Epic Games Store</i0>  
      <i1>Netflix</i1>  
      <i2>OnlyFans</i2>  
      <i3>Steam</i3>  
      <i4>Twitch TV</i4>  
    </entertainment>  
    <business>
      <i0>Google Docs</i0>  
      <i1>Google Sheets</i1>  
      <i2>Google Slides</i2>  
      <i3>Microsoft Excel</i3>  
      <i4>Microsoft PowerPoint</i4>  
      <i5>Microsoft Word</i5>  
    </business>  
    <website>
      <i0>Kickstarter</i0>  
      <i1>Medium</i1>  
      <i2>Quora</i2>  
    </website>  
    <unknown>
      <i0>Unknown</i0>  
    </unknown>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/easydeeplinks/list?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_shopping_0=Adidas
result_shopping_1=AliExpress
result_shopping_2=Amazon
result_shopping_3=Best Buy
result_shopping_4=eBay
result_shopping_5=Etsy
result_shopping_6=Flipkart
result_shopping_7=HSN
result_shopping_8=IKEA
result_shopping_9=Kaufland
result_shopping_10=Kohl's
result_shopping_11=LTK
result_shopping_12=Macy's
result_shopping_13=Mercado Livre
result_shopping_14=Nordstrom
result_shopping_15=Otto
result_shopping_16=QVC
result_shopping_17=SHEIN
result_shopping_18=Target
result_shopping_19=Temu
result_shopping_20=The Home Depot
result_shopping_21=Walmart
result_shopping_22=Zulily
result_lifestyle_0=Apartments.com
result_lifestyle_1=iFood
result_lifestyle_2=Trulia
result_lifestyle_3=Zillow
result_travel_0=Apple Maps
result_travel_1=Booking.com
result_travel_2=Expedia
result_travel_3=Google Maps
result_travel_4=TripAdvisor
result_music_0=Apple Music
result_music_1=Spotify
result_other_0=Apple Podcast
result_other_1=Zendesk Support
result_social_0=BlueSky
result_social_1=Discord
result_social_2=Facebook
result_social_3=Instagram
result_social_4=LINE
result_social_5=LinkedIn
result_social_6=Messenger
result_social_7=Pinterest
result_social_8=Product Hunt
result_social_9=Reddit
result_social_10=Signal
result_social_11=Skype
result_social_12=Snapchat
result_social_13=Telegram
result_social_14=TikTok
result_social_15=Viber
result_social_16=Vimeo
result_social_17=X
result_social_18=YouTube
result_affiliation_0=BrandCycle
result_affiliation_1=Howl
result_affiliation_2=MagicLinks
result_affiliation_3=Mavely
result_affiliation_4=Refersion
result_entertainment_0=Epic Games Store
result_entertainment_1=Netflix
result_entertainment_2=OnlyFans
result_entertainment_3=Steam
result_entertainment_4=Twitch TV
result_business_0=Google Docs
result_business_1=Google Sheets
result_business_2=Google Slides
result_business_3=Microsoft Excel
result_business_4=Microsoft PowerPoint
result_business_5=Microsoft Word
result_website_0=Kickstarter
result_website_1=Medium
result_website_2=Quora
result_unknown_0=Unknown

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/easydeeplinks/list?format=plain

Query parameters

format = plain

Response

Adidas
AliExpress
Amazon
Best Buy
eBay
Etsy
Flipkart
HSN
IKEA
Kaufland
Kohl's
LTK
Macy's
Mercado Livre
Nordstrom
Otto
QVC
SHEIN
Target
Temu
The Home Depot
Walmart
Zulily
Apartments.com
iFood
Trulia
Zillow
Apple Maps
Booking.com
Expedia
Google Maps
TripAdvisor
Apple Music
Spotify
Apple Podcast
Zendesk Support
BlueSky
Discord
Facebook
Instagram
LINE
LinkedIn
Messenger
Pinterest
Product Hunt
Reddit
Signal
Skype
Snapchat
Telegram
TikTok
Viber
Vimeo
X
YouTube
BrandCycle
Howl
MagicLinks
Mavely
Refersion
Epic Games Store
Netflix
OnlyFans
Steam
Twitch TV
Google Docs
Google Sheets
Google Slides
Microsoft Excel
Microsoft PowerPoint
Microsoft Word
Kickstarter
Medium
Quora
Unknown
Return values
parameterdescription
dataarray containing all supported apps for easy deep link grouped by category, it is in the form {"category1":[ list ], "category2":[ list ], ... }

/urls/edit

access: [WRITE]

Edit fields of a short URL.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/edit?id=a74ca8c2bef1a891fd63eb8335c26936&long_url=https%3A%2F%2Fwww.joturl.com%2F¬es=this+is+a+sample+note

Query parameters

      id = a74ca8c2bef1a891fd63eb8335c26936
long_url = https://www.joturl.com/
   notes = this is a sample note

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "a74ca8c2bef1a891fd63eb8335c26936",
    "alias": "jot",
    "domain_host": "jo.my",
    "domain_id": "62888ebd145c2cd42ac4e4f154c379b6",
    "project_id": "5e9c84c0245c82135627d58b0815e8e1",
    "project_name": "project name",
    "long_url": "https:\/\/www.joturl.com\/",
    "short_url": "http:\/\/jo.my\/jot",
    "notes": "this is a sample note"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/edit?id=a74ca8c2bef1a891fd63eb8335c26936&long_url=https%3A%2F%2Fwww.joturl.com%2F¬es=this+is+a+sample+note&format=xml

Query parameters

      id = a74ca8c2bef1a891fd63eb8335c26936
long_url = https://www.joturl.com/
   notes = this is a sample note
  format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>a74ca8c2bef1a891fd63eb8335c26936</id>  
    <alias>jot</alias>  
    <domain_host>jo.my</domain_host>  
    <domain_id>62888ebd145c2cd42ac4e4f154c379b6</domain_id>  
    <project_id>5e9c84c0245c82135627d58b0815e8e1</project_id>  
    <project_name>project name</project_name>  
    <long_url>https://www.joturl.com/</long_url>  
    <short_url>http://jo.my/jot</short_url>  
    <notes>this is a sample note</notes>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/edit?id=a74ca8c2bef1a891fd63eb8335c26936&long_url=https%3A%2F%2Fwww.joturl.com%2F¬es=this+is+a+sample+note&format=txt

Query parameters

      id = a74ca8c2bef1a891fd63eb8335c26936
long_url = https://www.joturl.com/
   notes = this is a sample note
  format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=a74ca8c2bef1a891fd63eb8335c26936
result_alias=jot
result_domain_host=jo.my
result_domain_id=62888ebd145c2cd42ac4e4f154c379b6
result_project_id=5e9c84c0245c82135627d58b0815e8e1
result_project_name=project name
result_long_url=https://www.joturl.com/
result_short_url=http://jo.my/jot
result_notes=this is a sample note

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/edit?id=a74ca8c2bef1a891fd63eb8335c26936&long_url=https%3A%2F%2Fwww.joturl.com%2F¬es=this+is+a+sample+note&format=plain

Query parameters

      id = a74ca8c2bef1a891fd63eb8335c26936
long_url = https://www.joturl.com/
   notes = this is a sample note
  format = plain

Response

http://jo.my/jot
Required parameters
parameterdescription
idIDID of the tracking link to be edited
Optional parameters
parameterdescriptionmax length
long_urlSTRINGdestination URL for tracking link4000
notesSTRINGnotes for tracking link255
Return values
parameterdescription
aliassee i1/urls/list for details
domain_hostdomain (e.g., domain.ext) of the tracking link
domain_idID of the domain of the tracking link
idsee i1/urls/list for details
long_urlsee i1/urls/list for details
notessee i1/urls/list for details
project_idID of the project
project_namename of the project
short_urlsee i1/urls/list for details

/urls/embeddable

access: [READ]

This method returns 1 if the passed URL is embeddable, 0 otherwise.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/embeddable?u=https%3A%2F%2Fwww.joturl.com%2F

Query parameters

u = https://www.joturl.com/

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "embeddable": 0
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/embeddable?u=https%3A%2F%2Fwww.joturl.com%2F&format=xml

Query parameters

     u = https://www.joturl.com/
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <embeddable>0</embeddable>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/embeddable?u=https%3A%2F%2Fwww.joturl.com%2F&format=txt

Query parameters

     u = https://www.joturl.com/
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_embeddable=0

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/embeddable?u=https%3A%2F%2Fwww.joturl.com%2F&format=plain

Query parameters

     u = https://www.joturl.com/
format = plain

Response

0
Required parameters
parameterdescription
uSTRINGURL to be checked
Return values
parameterdescription
embeddable1 if the URL is embeddable, 0 otherwise

/urls/export

access: [READ]

This method export the list of URLs in a user account.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/export

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 7,
    "remaining": 0,
    "tls": {
      "publication name 1": {
        "custom.domain3.ext": [
          {
            "alias": "alias0",
            "embed_code": "",
            "long_url": "https:\/\/my.destination.url\/?p=0",
            "visits": 36,
            "unique_visits": 13,
            "qrcodes_visits": 12
          },
          {
            "alias": "alias1",
            "embed_code": "",
            "long_url": "https:\/\/my.destination.url\/?p=1",
            "visits": 44,
            "unique_visits": 26,
            "qrcodes_visits": 12
          }
        ]
      },
      "publication name 2": {
        "custom.domain4.ext": [
          {
            "alias": "alias2",
            "embed_code": "",
            "long_url": "https:\/\/my.destination.url\/?p=2",
            "visits": 36,
            "unique_visits": 3,
            "qrcodes_visits": 1
          },
          {
            "alias": "alias3",
            "embed_code": "",
            "long_url": "https:\/\/my.destination.url\/?p=3",
            "visits": 73,
            "unique_visits": 46,
            "qrcodes_visits": 26
          },
          {
            "alias": "alias4",
            "embed_code": "",
            "long_url": "https:\/\/my.destination.url\/?p=4",
            "visits": 81,
            "unique_visits": 7,
            "qrcodes_visits": 6
          }
        ]
      },
      "publication name 3": {
        "custom.domain4.ext": [
          {
            "alias": "alias5",
            "embed_code": "",
            "long_url": "https:\/\/my.destination.url\/?p=5",
            "visits": 98,
            "unique_visits": 0,
            "qrcodes_visits": 0
          },
          {
            "alias": "alias6",
            "embed_code": "",
            "long_url": "https:\/\/my.destination.url\/?p=6",
            "visits": 49,
            "unique_visits": 43,
            "qrcodes_visits": 38
          }
        ]
      }
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/export?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>7</count>  
    <remaining>0</remaining>  
    <tls>
      <publication name 1>
        <custom.domain3.ext>
          <i0>
            <alias>alias0</alias>  
            <embed_code></embed_code>  
            <long_url>https://my.destination.url/?p=0</long_url>  
            <visits>36</visits>  
            <unique_visits>13</unique_visits>  
            <qrcodes_visits>12</qrcodes_visits>  
          </i0>  
          <i1>
            <alias>alias1</alias>  
            <embed_code></embed_code>  
            <long_url>https://my.destination.url/?p=1</long_url>  
            <visits>44</visits>  
            <unique_visits>26</unique_visits>  
            <qrcodes_visits>12</qrcodes_visits>  
          </i1>  
        </custom.domain3.ext>  
      </publication name 1>  
      <publication name 2>
        <custom.domain4.ext>
          <i0>
            <alias>alias2</alias>  
            <embed_code></embed_code>  
            <long_url>https://my.destination.url/?p=2</long_url>  
            <visits>36</visits>  
            <unique_visits>3</unique_visits>  
            <qrcodes_visits>1</qrcodes_visits>  
          </i0>  
          <i1>
            <alias>alias3</alias>  
            <embed_code></embed_code>  
            <long_url>https://my.destination.url/?p=3</long_url>  
            <visits>73</visits>  
            <unique_visits>46</unique_visits>  
            <qrcodes_visits>26</qrcodes_visits>  
          </i1>  
          <i2>
            <alias>alias4</alias>  
            <embed_code></embed_code>  
            <long_url>https://my.destination.url/?p=4</long_url>  
            <visits>81</visits>  
            <unique_visits>7</unique_visits>  
            <qrcodes_visits>6</qrcodes_visits>  
          </i2>  
        </custom.domain4.ext>  
      </publication name 2>  
      <publication name 3>
        <custom.domain4.ext>
          <i0>
            <alias>alias5</alias>  
            <embed_code></embed_code>  
            <long_url>https://my.destination.url/?p=5</long_url>  
            <visits>98</visits>  
            <unique_visits>0</unique_visits>  
            <qrcodes_visits>0</qrcodes_visits>  
          </i0>  
          <i1>
            <alias>alias6</alias>  
            <embed_code></embed_code>  
            <long_url>https://my.destination.url/?p=6</long_url>  
            <visits>49</visits>  
            <unique_visits>43</unique_visits>  
            <qrcodes_visits>38</qrcodes_visits>  
          </i1>  
        </custom.domain4.ext>  
      </publication name 3>  
    </tls>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/export?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=7
result_remaining=0
result_tls_publication name 1_custom.domain3.ext_0_alias=alias0
result_tls_publication name 1_custom.domain3.ext_0_embed_code=
result_tls_publication name 1_custom.domain3.ext_0_long_url=https://my.destination.url/?p=0
result_tls_publication name 1_custom.domain3.ext_0_visits=36
result_tls_publication name 1_custom.domain3.ext_0_unique_visits=13
result_tls_publication name 1_custom.domain3.ext_0_qrcodes_visits=12
result_tls_publication name 1_custom.domain3.ext_1_alias=alias1
result_tls_publication name 1_custom.domain3.ext_1_embed_code=
result_tls_publication name 1_custom.domain3.ext_1_long_url=https://my.destination.url/?p=1
result_tls_publication name 1_custom.domain3.ext_1_visits=44
result_tls_publication name 1_custom.domain3.ext_1_unique_visits=26
result_tls_publication name 1_custom.domain3.ext_1_qrcodes_visits=12
result_tls_publication name 2_custom.domain4.ext_0_alias=alias2
result_tls_publication name 2_custom.domain4.ext_0_embed_code=
result_tls_publication name 2_custom.domain4.ext_0_long_url=https://my.destination.url/?p=2
result_tls_publication name 2_custom.domain4.ext_0_visits=36
result_tls_publication name 2_custom.domain4.ext_0_unique_visits=3
result_tls_publication name 2_custom.domain4.ext_0_qrcodes_visits=1
result_tls_publication name 2_custom.domain4.ext_1_alias=alias3
result_tls_publication name 2_custom.domain4.ext_1_embed_code=
result_tls_publication name 2_custom.domain4.ext_1_long_url=https://my.destination.url/?p=3
result_tls_publication name 2_custom.domain4.ext_1_visits=73
result_tls_publication name 2_custom.domain4.ext_1_unique_visits=46
result_tls_publication name 2_custom.domain4.ext_1_qrcodes_visits=26
result_tls_publication name 2_custom.domain4.ext_2_alias=alias4
result_tls_publication name 2_custom.domain4.ext_2_embed_code=
result_tls_publication name 2_custom.domain4.ext_2_long_url=https://my.destination.url/?p=4
result_tls_publication name 2_custom.domain4.ext_2_visits=81
result_tls_publication name 2_custom.domain4.ext_2_unique_visits=7
result_tls_publication name 2_custom.domain4.ext_2_qrcodes_visits=6
result_tls_publication name 3_custom.domain4.ext_0_alias=alias5
result_tls_publication name 3_custom.domain4.ext_0_embed_code=
result_tls_publication name 3_custom.domain4.ext_0_long_url=https://my.destination.url/?p=5
result_tls_publication name 3_custom.domain4.ext_0_visits=98
result_tls_publication name 3_custom.domain4.ext_0_unique_visits=0
result_tls_publication name 3_custom.domain4.ext_0_qrcodes_visits=0
result_tls_publication name 3_custom.domain4.ext_1_alias=alias6
result_tls_publication name 3_custom.domain4.ext_1_embed_code=
result_tls_publication name 3_custom.domain4.ext_1_long_url=https://my.destination.url/?p=6
result_tls_publication name 3_custom.domain4.ext_1_visits=49
result_tls_publication name 3_custom.domain4.ext_1_unique_visits=43
result_tls_publication name 3_custom.domain4.ext_1_qrcodes_visits=38

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/export?format=plain

Query parameters

format = plain

Response

7
0
alias0

https://my.destination.url/?p=0
36
13
12
alias1

https://my.destination.url/?p=1
44
26
12
alias2

https://my.destination.url/?p=2
36
3
1
alias3

https://my.destination.url/?p=3
73
46
26
alias4

https://my.destination.url/?p=4
81
7
6
alias5

https://my.destination.url/?p=5
98
0
0
alias6

https://my.destination.url/?p=6
49
43
38
Optional parameters
parameterdescription
startINTEGERthe position from which to start the extraction
Return values
parameterdescription
counttotal number of tracking links
next[OPTIONAL] the URL to be called to obtain the next tracking links, the export ends if this parameter does not exist or the URL is empty
remainingremaining tracking links after the export call, the export ends if this parameter is 0
tlsarray containing the exported tracking links

/urls/hub

/urls/hub/check

access: [READ]

This method performs an advanced check of conditions in the hub.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/hub/check?controller_id=f2883b3b68b0d648570ecf5ec65d139c

Query parameters

controller_id = f2883b3b68b0d648570ecf5ec65d139c

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": [
      {
        "url_id": "b6d9828ed8a3274fe6578db20834c82e",
        "condition": "#referrer# CON 'facebook.com'",
        "warning": {
          "type": "not_reached",
          "message": "condition is never reached"
        }
      },
      {
        "url_id": "b6d9828ed8a3274fe6578db20834c82e",
        "condition": "#os# == 'android'",
        "warning": {
          "type": "=true",
          "message": "condition is always true"
        }
      },
      {
        "url_id": "c690e145210b04260892ec5b842c2499",
        "condition": "#os# != 'android'",
        "warning": {
          "type": "=false",
          "message": "condition is always false"
        }
      },
      {
        "url_id": "f2883b3b68b0d648570ecf5ec65d139c",
        "condition": "",
        "warning": {
          "type": "controller_url",
          "message": "the controller destination URL is never reached (at least one rule is always true)"
        }
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/hub/check?controller_id=f2883b3b68b0d648570ecf5ec65d139c&format=xml

Query parameters

controller_id = f2883b3b68b0d648570ecf5ec65d139c
       format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <i0>
        <url_id>b6d9828ed8a3274fe6578db20834c82e</url_id>  
        <condition>#referrer# CON 'facebook.com'</condition>  
        <warning>
          <type>not_reached</type>  
          <message>condition is never reached</message>  
        </warning>  
      </i0>  
      <i1>
        <url_id>b6d9828ed8a3274fe6578db20834c82e</url_id>  
        <condition>#os# == 'android'</condition>  
        <warning>
          <type>=true</type>  
          <message>condition is always true</message>  
        </warning>  
      </i1>  
      <i2>
        <url_id>c690e145210b04260892ec5b842c2499</url_id>  
        <condition>#os# != 'android'</condition>  
        <warning>
          <type>=false</type>  
          <message>condition is always false</message>  
        </warning>  
      </i2>  
      <i3>
        <url_id>f2883b3b68b0d648570ecf5ec65d139c</url_id>  
        <condition></condition>  
        <warning>
          <type>controller_url</type>  
          <message>the controller destination URL is never reached (at least one rule is always true)</message>  
        </warning>  
      </i3>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/hub/check?controller_id=f2883b3b68b0d648570ecf5ec65d139c&format=txt

Query parameters

controller_id = f2883b3b68b0d648570ecf5ec65d139c
       format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_0_url_id=b6d9828ed8a3274fe6578db20834c82e
result_data_0_condition=#referrer# CON 'facebook.com'
result_data_0_warning_type=not_reached
result_data_0_warning_message=condition is never reached
result_data_1_url_id=b6d9828ed8a3274fe6578db20834c82e
result_data_1_condition=#os# == 'android'
result_data_1_warning_type==true
result_data_1_warning_message=condition is always true
result_data_2_url_id=c690e145210b04260892ec5b842c2499
result_data_2_condition=#os# != 'android'
result_data_2_warning_type==false
result_data_2_warning_message=condition is always false
result_data_3_url_id=f2883b3b68b0d648570ecf5ec65d139c
result_data_3_condition=
result_data_3_warning_type=controller_url
result_data_3_warning_message=the controller destination URL is never reached (at least one rule is always true)

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/hub/check?controller_id=f2883b3b68b0d648570ecf5ec65d139c&format=plain

Query parameters

controller_id = f2883b3b68b0d648570ecf5ec65d139c
       format = plain

Response

b6d9828ed8a3274fe6578db20834c82e
#referrer# CON 'facebook.com'
not_reached
condition is never reached
b6d9828ed8a3274fe6578db20834c82e
#os# == 'android'
=true
condition is always true
c690e145210b04260892ec5b842c2499
#os# != 'android'
=false
condition is always false
f2883b3b68b0d648570ecf5ec65d139c

controller_url
the controller destination URL is never reached (at least one rule is always true)
Required parameters
parameterdescription
controller_idIDID of the controller tracking link
Return values
parameterdescription
dataarray containing information about rule checks, empty if no anomalies are detected

/urls/hub/clone

access: [WRITE]

Clone the hub configuration from a tracking link to another.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/hub/clone?from_url_id=e680558d141dae71761f9fde09392687&to_url_id=195d17132ce3d7e3a1cca88d46680086

Query parameters

from_url_id = e680558d141dae71761f9fde09392687
  to_url_id = 195d17132ce3d7e3a1cca88d46680086

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "cloned": 0
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/hub/clone?from_url_id=e680558d141dae71761f9fde09392687&to_url_id=195d17132ce3d7e3a1cca88d46680086&format=xml

Query parameters

from_url_id = e680558d141dae71761f9fde09392687
  to_url_id = 195d17132ce3d7e3a1cca88d46680086
     format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <cloned>0</cloned>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/hub/clone?from_url_id=e680558d141dae71761f9fde09392687&to_url_id=195d17132ce3d7e3a1cca88d46680086&format=txt

Query parameters

from_url_id = e680558d141dae71761f9fde09392687
  to_url_id = 195d17132ce3d7e3a1cca88d46680086
     format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_cloned=0

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/hub/clone?from_url_id=e680558d141dae71761f9fde09392687&to_url_id=195d17132ce3d7e3a1cca88d46680086&format=plain

Query parameters

from_url_id = e680558d141dae71761f9fde09392687
  to_url_id = 195d17132ce3d7e3a1cca88d46680086
     format = plain

Response

0
Required parameters
parameterdescription
from_url_idIDID of the tracking link you want to copy the hub configuration from
to_url_idIDID of the tracking link you want to the hub configuration to
Return values
parameterdescription
cloned1 on success, 0 otherwise

/urls/hub/conditions

/urls/hub/conditions/add

access: [WRITE]

Add a new condition to the URL hub.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/hub/conditions/add?url_id=08c9ac453deb16a332dd45e4ed6164e7&controller_id=27f9875bf1b81692510b3117fb1aac3f&condition=%23language%23+%3D+%27DE%27

Query parameters

       url_id = 08c9ac453deb16a332dd45e4ed6164e7
controller_id = 27f9875bf1b81692510b3117fb1aac3f
    condition = #language# = 'DE'

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "added": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/hub/conditions/add?url_id=08c9ac453deb16a332dd45e4ed6164e7&controller_id=27f9875bf1b81692510b3117fb1aac3f&condition=%23language%23+%3D+%27DE%27&format=xml

Query parameters

       url_id = 08c9ac453deb16a332dd45e4ed6164e7
controller_id = 27f9875bf1b81692510b3117fb1aac3f
    condition = #language# = 'DE'
       format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <added>1</added>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/hub/conditions/add?url_id=08c9ac453deb16a332dd45e4ed6164e7&controller_id=27f9875bf1b81692510b3117fb1aac3f&condition=%23language%23+%3D+%27DE%27&format=txt

Query parameters

       url_id = 08c9ac453deb16a332dd45e4ed6164e7
controller_id = 27f9875bf1b81692510b3117fb1aac3f
    condition = #language# = 'DE'
       format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_added=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/hub/conditions/add?url_id=08c9ac453deb16a332dd45e4ed6164e7&controller_id=27f9875bf1b81692510b3117fb1aac3f&condition=%23language%23+%3D+%27DE%27&format=plain

Query parameters

       url_id = 08c9ac453deb16a332dd45e4ed6164e7
controller_id = 27f9875bf1b81692510b3117fb1aac3f
    condition = #language# = 'DE'
       format = plain

Response

1
Required parameters
parameterdescription
conditionHTMLif this condition is met, the engine redirects to the tracking link identified by url_id
controller_idIDID of the root tracking link
url_idIDID of the tracking link to be used if the condition is met
Optional parameters
parameterdescription
old_url_idIDID of the existing tracking link in the hub to be replaced with the new one identified by url_id
Return values
parameterdescription
added1 on success (the new condition is added/replaced), 0 otherwise
/urls/hub/conditions/check

access: [READ]

This method check the validity of a condition to be used with the hub.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/hub/conditions/check?condition=%23language%23+%3D+%27FR%27

Query parameters

condition = #language# = 'FR'

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": 1
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/hub/conditions/check?condition=%23language%23+%3D+%27FR%27&format=xml

Query parameters

condition = #language# = 'FR'
   format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>1</result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/hub/conditions/check?condition=%23language%23+%3D+%27FR%27&format=txt

Query parameters

condition = #language# = 'FR'
   format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/hub/conditions/check?condition=%23language%23+%3D+%27FR%27&format=plain

Query parameters

condition = #language# = 'FR'
   format = plain

Response

Required parameters
parameterdescription
conditionHTMLcondition to check
Return values
parameterdescription
result1 if the condition is valid, an invalid parameter error with a detailed error is returned otherwise
/urls/hub/conditions/decompile

access: [READ]

This method decompiles a condition by exploding it into parts.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/hub/conditions/decompile?condition=%23language%23+%3D+%27FR%27

Query parameters

condition = #language# = 'FR'

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "parts": [
      {
        "level": 0,
        "variable": "language",
        "operator": "=",
        "value": "FR"
      }
    ],
    "operators": {
      "language": {
        "=": "equal to",
        "!=": "not equal to"
      }
    },
    "values": {
      "language": {
        "AF": "Afrikaans",
        "AR": "Arabic - \u0627\u0644\u0639\u0631\u0628\u064a\u0629",
        "[...]": "[...]",
        "*": "custom (replace * with the ISO 639-1 code of the language)"
      }
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/hub/conditions/decompile?condition=%23language%23+%3D+%27FR%27&format=xml

Query parameters

condition = #language# = 'FR'
   format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <parts>
      <i0>
        <level>0</level>  
        <variable>language</variable>  
        <operator>=</operator>  
        <value>FR</value>  
      </i0>  
    </parts>  
    <operators>
      <language>
        <=>equal to</=>  
        <!=>not equal to</!=>  
      </language>  
    </operators>  
    <values>
      <language>
        <AF>Afrikaans</AF>  
        <AR>Arabic - العربية</AR>  
        <[...]>[...]</[...]>  
        <*>custom (replace * with the ISO 639-1 code of the language)</*>  
      </language>  
    </values>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/hub/conditions/decompile?condition=%23language%23+%3D+%27FR%27&format=txt

Query parameters

condition = #language# = 'FR'
   format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_parts_0_level=0
result_parts_0_variable=language
result_parts_0_operator==
result_parts_0_value=FR
result_operators_language_==equal to
result_operators_language_!==not equal to
result_values_language_AF=Afrikaans
result_values_language_AR=Arabic - العربية
result_values_language_[...]=[...]
result_values_language_*=custom (replace * with the ISO 639-1 code of the language)

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/hub/conditions/decompile?condition=%23language%23+%3D+%27FR%27&format=plain

Query parameters

condition = #language# = 'FR'
   format = plain

Response

0
language
=
FR
equal to
not equal to
Afrikaans
Arabic - العربية
[...]
custom (replace * with the ISO 639-1 code of the language)

Example 5 (json)

Request

https://joturl.com/a/i1/urls/hub/conditions/decompile?condition=%23country%23+%21%3D+%27AT%27++AND+%28+%23language%23+%3D+%27AF%27++OR++%23language%23+%3D+%27DA%27+%29

Query parameters

condition = #country# != 'AT'  AND ( #language# = 'AF'  OR  #language# = 'DA' )

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "parts": [
      {
        "level": 0,
        "variable": "country",
        "operator": "!=",
        "value": "AT"
      },
      {
        "level": 0,
        "boolean": "AND"
      },
      {
        "level": 1,
        "variable": "language",
        "operator": "=",
        "value": "AF"
      },
      {
        "level": 1,
        "boolean": "OR"
      },
      {
        "level": 1,
        "variable": "language",
        "operator": "=",
        "value": "DA"
      }
    ],
    "operators": {
      "country": {
        "=": "equal to",
        "!=": "not equal to"
      },
      "language": {
        "=": "equal to",
        "!=": "not equal to"
      }
    },
    "values": {
      "country": {
        "AF": "Afghanistan (\u0627\u0641\u063a\u0627\u0646\u0633\u062a\u0627\u0646)",
        "AX": "Aland Islands",
        "[...]": "[...]",
        "unk": "Other or unrecognized"
      },
      "language": {
        "AF": "Afrikaans",
        "AR": "Arabic - \u0627\u0644\u0639\u0631\u0628\u064a\u0629",
        "[...]": "[...]",
        "*": "custom (replace * with the ISO 639-1 code of the language)"
      }
    }
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/urls/hub/conditions/decompile?condition=%23country%23+%21%3D+%27AT%27++AND+%28+%23language%23+%3D+%27AF%27++OR++%23language%23+%3D+%27DA%27+%29&format=xml

Query parameters

condition = #country# != 'AT'  AND ( #language# = 'AF'  OR  #language# = 'DA' )
   format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <parts>
      <i0>
        <level>0</level>  
        <variable>country</variable>  
        <operator>!=</operator>  
        <value>AT</value>  
      </i0>  
      <i1>
        <level>0</level>  
        <boolean>AND</boolean>  
      </i1>  
      <i2>
        <level>1</level>  
        <variable>language</variable>  
        <operator>=</operator>  
        <value>AF</value>  
      </i2>  
      <i3>
        <level>1</level>  
        <boolean>OR</boolean>  
      </i3>  
      <i4>
        <level>1</level>  
        <variable>language</variable>  
        <operator>=</operator>  
        <value>DA</value>  
      </i4>  
    </parts>  
    <operators>
      <country>
        <=>equal to</=>  
        <!=>not equal to</!=>  
      </country>  
      <language>
        <=>equal to</=>  
        <!=>not equal to</!=>  
      </language>  
    </operators>  
    <values>
      <country>
        <AF>Afghanistan (افغانستان)</AF>  
        <AX>Aland Islands</AX>  
        <[...]>[...]</[...]>  
        <unk>Other or unrecognized</unk>  
      </country>  
      <language>
        <AF>Afrikaans</AF>  
        <AR>Arabic - العربية</AR>  
        <[...]>[...]</[...]>  
        <*>custom (replace * with the ISO 639-1 code of the language)</*>  
      </language>  
    </values>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/urls/hub/conditions/decompile?condition=%23country%23+%21%3D+%27AT%27++AND+%28+%23language%23+%3D+%27AF%27++OR++%23language%23+%3D+%27DA%27+%29&format=txt

Query parameters

condition = #country# != 'AT'  AND ( #language# = 'AF'  OR  #language# = 'DA' )
   format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_parts_0_level=0
result_parts_0_variable=country
result_parts_0_operator=!=
result_parts_0_value=AT
result_parts_1_level=0
result_parts_1_boolean=AND
result_parts_2_level=1
result_parts_2_variable=language
result_parts_2_operator==
result_parts_2_value=AF
result_parts_3_level=1
result_parts_3_boolean=OR
result_parts_4_level=1
result_parts_4_variable=language
result_parts_4_operator==
result_parts_4_value=DA
result_operators_country_==equal to
result_operators_country_!==not equal to
result_operators_language_==equal to
result_operators_language_!==not equal to
result_values_country_AF=Afghanistan (افغانستان)
result_values_country_AX=Aland Islands
result_values_country_[...]=[...]
result_values_country_unk=Other or unrecognized
result_values_language_AF=Afrikaans
result_values_language_AR=Arabic - العربية
result_values_language_[...]=[...]
result_values_language_*=custom (replace * with the ISO 639-1 code of the language)

Example 8 (plain)

Request

https://joturl.com/a/i1/urls/hub/conditions/decompile?condition=%23country%23+%21%3D+%27AT%27++AND+%28+%23language%23+%3D+%27AF%27++OR++%23language%23+%3D+%27DA%27+%29&format=plain

Query parameters

condition = #country# != 'AT'  AND ( #language# = 'AF'  OR  #language# = 'DA' )
   format = plain

Response

0
country
!=
AT
0
AND
1
language
=
AF
1
OR
1
language
=
DA
equal to
not equal to
equal to
not equal to
Afghanistan (افغانستان)
Aland Islands
[...]
Other or unrecognized
Afrikaans
Arabic - العربية
[...]
custom (replace * with the ISO 639-1 code of the language)
Required parameters
parameterdescription
conditionHTMLcondition to decompile
Return values
parameterdescription
operatorsforeach varible in parts, it contains the allowed operators
partsparts of the condition in the format (level,variable,operator,value) or (level,boolean), where level is the variable of the boolean level (variables/booleans with the same level must be considered in brackets), variable is its name, operator and value are its operator and value, respectively; boolean can be AND or OR
valuesforeach varible in parts, it contains the allowed values
/urls/hub/conditions/delete

access: [WRITE]

This method allows you to remove a tracking link from the URL hub.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/hub/conditions/delete?url_id=0f7f63b243d5416f449946ce8d3dd6d2&controller_id=7eb6b3ce31ca14f3898b324532a06706

Query parameters

       url_id = 0f7f63b243d5416f449946ce8d3dd6d2
controller_id = 7eb6b3ce31ca14f3898b324532a06706

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1,
    "isActive": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/hub/conditions/delete?url_id=0f7f63b243d5416f449946ce8d3dd6d2&controller_id=7eb6b3ce31ca14f3898b324532a06706&format=xml

Query parameters

       url_id = 0f7f63b243d5416f449946ce8d3dd6d2
controller_id = 7eb6b3ce31ca14f3898b324532a06706
       format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
    <isActive>1</isActive>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/hub/conditions/delete?url_id=0f7f63b243d5416f449946ce8d3dd6d2&controller_id=7eb6b3ce31ca14f3898b324532a06706&format=txt

Query parameters

       url_id = 0f7f63b243d5416f449946ce8d3dd6d2
controller_id = 7eb6b3ce31ca14f3898b324532a06706
       format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1
result_isActive=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/hub/conditions/delete?url_id=0f7f63b243d5416f449946ce8d3dd6d2&controller_id=7eb6b3ce31ca14f3898b324532a06706&format=plain

Query parameters

       url_id = 0f7f63b243d5416f449946ce8d3dd6d2
controller_id = 7eb6b3ce31ca14f3898b324532a06706
       format = plain

Response

1
1
Required parameters
parameterdescription
controller_idIDID of the root tracking link
url_idIDID of the tracking link to remove
Return values
parameterdescription
deleted1 on success (the new tracking link is deleted), 0 otherwise
isActive1 if the hub is still active after deleting the tracking link identified by url_id (i.e., the hub has at least 2 tracking links, including the root tracking link), 0 otherwise
/urls/hub/conditions/order

access: [WRITE]

This method allows you to set the order for the tracking links of a hub URL.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/hub/conditions/order?controller_id=78c36c9d3eb6ab588eaeed36b6158ec7&ids%5B0%5D=ada489a820a730a49a09651014170fbc&ids%5B1%5D=322de96caf8cec6112939ab0aa9ab697&orders%5B0%5D=2&orders%5B1%5D=1

Query parameters

controller_id = 78c36c9d3eb6ab588eaeed36b6158ec7
       ids[0] = ada489a820a730a49a09651014170fbc
       ids[1] = 322de96caf8cec6112939ab0aa9ab697
    orders[0] = 2
    orders[1] = 1

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "modified": 2,
    "isActive": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/hub/conditions/order?controller_id=78c36c9d3eb6ab588eaeed36b6158ec7&ids%5B0%5D=ada489a820a730a49a09651014170fbc&ids%5B1%5D=322de96caf8cec6112939ab0aa9ab697&orders%5B0%5D=2&orders%5B1%5D=1&format=xml

Query parameters

controller_id = 78c36c9d3eb6ab588eaeed36b6158ec7
       ids[0] = ada489a820a730a49a09651014170fbc
       ids[1] = 322de96caf8cec6112939ab0aa9ab697
    orders[0] = 2
    orders[1] = 1
       format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <modified>2</modified>  
    <isActive>1</isActive>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/hub/conditions/order?controller_id=78c36c9d3eb6ab588eaeed36b6158ec7&ids%5B0%5D=ada489a820a730a49a09651014170fbc&ids%5B1%5D=322de96caf8cec6112939ab0aa9ab697&orders%5B0%5D=2&orders%5B1%5D=1&format=txt

Query parameters

controller_id = 78c36c9d3eb6ab588eaeed36b6158ec7
       ids[0] = ada489a820a730a49a09651014170fbc
       ids[1] = 322de96caf8cec6112939ab0aa9ab697
    orders[0] = 2
    orders[1] = 1
       format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_modified=2
result_isActive=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/hub/conditions/order?controller_id=78c36c9d3eb6ab588eaeed36b6158ec7&ids%5B0%5D=ada489a820a730a49a09651014170fbc&ids%5B1%5D=322de96caf8cec6112939ab0aa9ab697&orders%5B0%5D=2&orders%5B1%5D=1&format=plain

Query parameters

controller_id = 78c36c9d3eb6ab588eaeed36b6158ec7
       ids[0] = ada489a820a730a49a09651014170fbc
       ids[1] = 322de96caf8cec6112939ab0aa9ab697
    orders[0] = 2
    orders[1] = 1
       format = plain

Response

2
1
Required parameters
parameterdescription
controller_idIDID of the root tracking link
idsARRAY_OF_IDSlist of tracking link IDs for which to set the order
ordersARRAYlist of integers defining the order of tracking links identified by ids
Return values
parameterdescription
isActive1 if the hub is still active after reordering the tracking links, 0 otherwise
modifiedtracking link number whose ordering has actually changed

/urls/hub/debug

access: [READ]

Get a debug URL for a specific hub.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/hub/debug?controller_id=56aa9fd50f547ba929fe101e953eb35c

Query parameters

controller_id = 56aa9fd50f547ba929fe101e953eb35c

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "debug_url": "https:\/\/jo.my\/joturl?9774AA75!dbg",
    "valid_until": "2025-06-27T16:53:15+00:00"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/hub/debug?controller_id=56aa9fd50f547ba929fe101e953eb35c&format=xml

Query parameters

controller_id = 56aa9fd50f547ba929fe101e953eb35c
       format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <debug_url>https://jo.my/joturl?9774AA75!dbg</debug_url>  
    <valid_until>2025-06-27T16:53:15+00:00</valid_until>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/hub/debug?controller_id=56aa9fd50f547ba929fe101e953eb35c&format=txt

Query parameters

controller_id = 56aa9fd50f547ba929fe101e953eb35c
       format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_debug_url=https://jo.my/joturl?9774AA75!dbg
result_valid_until=2025-06-27T16:53:15+00:00

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/hub/debug?controller_id=56aa9fd50f547ba929fe101e953eb35c&format=plain

Query parameters

controller_id = 56aa9fd50f547ba929fe101e953eb35c
       format = plain

Response

https://jo.my/joturl?9774AA75!dbg
2025-06-27T16:53:15+00:00
Required parameters
parameterdescription
controller_idIDID of the root tracking link
Return values
parameterdescription
debug_urldebug URL
valid_untilexpiration date for the debug URL (ISO 8601 date format, e.g., 2025-06-27T16:53:15+00:00)

/urls/hub/delete

access: [WRITE]

Delete a URL hub.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/hub/delete?controller_id=7a23c16564fca371dd4eadec91f87628

Query parameters

controller_id = 7a23c16564fca371dd4eadec91f87628

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/hub/delete?controller_id=7a23c16564fca371dd4eadec91f87628&format=xml

Query parameters

controller_id = 7a23c16564fca371dd4eadec91f87628
       format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/hub/delete?controller_id=7a23c16564fca371dd4eadec91f87628&format=txt

Query parameters

controller_id = 7a23c16564fca371dd4eadec91f87628
       format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/hub/delete?controller_id=7a23c16564fca371dd4eadec91f87628&format=plain

Query parameters

controller_id = 7a23c16564fca371dd4eadec91f87628
       format = plain

Response

1
Required parameters
parameterdescription
controller_idIDID of the tracking link from which to remove a URL hub
Return values
parameterdescription
deleted1 on success, 0 otherwise

/urls/hub/info

access: [READ]

Returns the URLs associated with a URL hub.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/hub/info?controller_id=acd4f96c0b1130a9234cf1e369385d9f

Query parameters

controller_id = acd4f96c0b1130a9234cf1e369385d9f

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": [
    {
      "url_id": "f54467f64dd7ea313220b059a9632084",
      "short_url": "https:\/\/jo.my\/tracking_link_condition_1",
      "condition": "#language# = 'IT'"
    },
    {
      "url_id": "944b326f41371c1a545da1c394132f01",
      "short_url": "https:\/\/jo.my\/tracking_link_condition_2",
      "condition": "#language# = 'DE'"
    }
  ]
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/hub/info?controller_id=acd4f96c0b1130a9234cf1e369385d9f&format=xml

Query parameters

controller_id = acd4f96c0b1130a9234cf1e369385d9f
       format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <i0>
      <url_id>f54467f64dd7ea313220b059a9632084</url_id>  
      <short_url>https://jo.my/tracking_link_condition_1</short_url>  
      <condition>#language# = 'IT'</condition>  
    </i0>  
    <i1>
      <url_id>944b326f41371c1a545da1c394132f01</url_id>  
      <short_url>https://jo.my/tracking_link_condition_2</short_url>  
      <condition>#language# = 'DE'</condition>  
    </i1>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/hub/info?controller_id=acd4f96c0b1130a9234cf1e369385d9f&format=txt

Query parameters

controller_id = acd4f96c0b1130a9234cf1e369385d9f
       format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_0_url_id=f54467f64dd7ea313220b059a9632084
result_0_short_url=https://jo.my/tracking_link_condition_1
result_0_condition=#language# = 'IT'
result_1_url_id=944b326f41371c1a545da1c394132f01
result_1_short_url=https://jo.my/tracking_link_condition_2
result_1_condition=#language# = 'DE'

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/hub/info?controller_id=acd4f96c0b1130a9234cf1e369385d9f&format=plain

Query parameters

controller_id = acd4f96c0b1130a9234cf1e369385d9f
       format = plain

Response

https://jo.my/tracking_link_condition_1
https://jo.my/tracking_link_condition_2
Required parameters
parameterdescription
controller_idIDID of the controller tracking link
Return values
parameterdescription
dataarray of objects in the format ( url_id, short_url, condition), where url_id is the tracking link ID, short_url is the tracking link itself and condition is the condition to be satisfied to redirect to the aforementioned tracking link. A maximum of 100 items are returned (the limit on the number of conditions that can be created)

/urls/hub/variable

access: [READ]

This method returns a list of variables that can be used with the Smart Redirector. Furthermore, if parameter name is passed, possible accepted operators and values are returned.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/hub/variable

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "variables": {
      "language": "Language",
      "country": "Country",
      "os": "Operating system",
      "os_version": "Operating system version",
      "mobile_device": "Mobile device",
      "browser": "Browser",
      "browser_type": "Browser type",
      "browser_version": "Main browser version",
      "visits": "Visits",
      "unique_visits": "Unique visits",
      "is_qrcode": "QR-Code?",
      "visited": "Already visited?",
      "time": "Time (UTC)",
      "datetime": "Date\/Time (UTC)",
      "referrer": "Referrer",
      "user_agent": "User agent"
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/hub/variable?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <variables>
      <language>Language</language>  
      <country>Country</country>  
      <os>Operating system</os>  
      <os_version>Operating system version</os_version>  
      <mobile_device>Mobile device</mobile_device>  
      <browser>Browser</browser>  
      <browser_type>Browser type</browser_type>  
      <browser_version>Main browser version</browser_version>  
      <visits>Visits</visits>  
      <unique_visits>Unique visits</unique_visits>  
      <is_qrcode>QR-Code?</is_qrcode>  
      <visited>Already visited?</visited>  
      <time>Time (UTC)</time>  
      <datetime>Date/Time (UTC)</datetime>  
      <referrer>Referrer</referrer>  
      <user_agent>User agent</user_agent>  
    </variables>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/hub/variable?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_variables_language=Language
result_variables_country=Country
result_variables_os=Operating system
result_variables_os_version=Operating system version
result_variables_mobile_device=Mobile device
result_variables_browser=Browser
result_variables_browser_type=Browser type
result_variables_browser_version=Main browser version
result_variables_visits=Visits
result_variables_unique_visits=Unique visits
result_variables_is_qrcode=QR-Code?
result_variables_visited=Already visited?
result_variables_time=Time (UTC)
result_variables_datetime=Date/Time (UTC)
result_variables_referrer=Referrer
result_variables_user_agent=User agent

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/hub/variable?format=plain

Query parameters

format = plain

Response

Language
Country
Operating system
Operating system version
Mobile device
Browser
Browser type
Main browser version
Visits
Unique visits
QR-Code?
Already visited?
Time (UTC)
Date/Time (UTC)
Referrer
User agent

Example 5 (json)

Request

https://joturl.com/a/i1/urls/hub/variable?0=11

Query parameters

0 = 11

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": []
}

Example 6 (xml)

Request

https://joturl.com/a/i1/urls/hub/variable?0=11&format=xml

Query parameters

     0 = 11
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>

  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/urls/hub/variable?0=11&format=txt

Query parameters

     0 = 11
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result=

Example 8 (plain)

Request

https://joturl.com/a/i1/urls/hub/variable?0=11&format=plain

Query parameters

     0 = 11
format = plain

Response

Optional parameters
parameterdescription
nameSTRINGname of the variable for which to extract the possible operators and values
Return values
parameterdescription
operators[OPTIONAL] array containing a list of available operators for the given variable name, it is passed only if name is passed
values[OPTIONAL] array containing a list of available values for the given variable name, it is passed only if name is passed
variablesarray containing a list of available variables

/urls/import

access: [WRITE]

This method import tracking links into a specific project.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/import?domain_id=df7e48c2661da298a11d9499deffac39

Query parameters

domain_id = df7e48c2661da298a11d9499deffac39

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "imported": 897,
    "errors": []
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/import?domain_id=df7e48c2661da298a11d9499deffac39&format=xml

Query parameters

domain_id = df7e48c2661da298a11d9499deffac39
   format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <imported>897</imported>  
    <errors>

    </errors>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/import?domain_id=df7e48c2661da298a11d9499deffac39&format=txt

Query parameters

domain_id = df7e48c2661da298a11d9499deffac39
   format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_imported=897
result_errors=

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/import?domain_id=df7e48c2661da298a11d9499deffac39&format=plain

Query parameters

domain_id = df7e48c2661da298a11d9499deffac39
   format = plain

Response

897

Required parameters
parameterdescription
domain_idIDID of the domain on which to import tracking links
inputSTRINGname of the HTML form field that is used to transfer the CSV file
Optional parameters
parameterdescription
check_onlyBOOLEANif 1 only a file check is required, no tracking link will be imported, default: 0
csv_has_headerBOOLEAN1 if the CSV file has a header line, default: 0
csv_sepSTRINGCSV delimiter, default: ; (semicolon)
project_idIDID of the project on which to import tracking links, if not specified the default will be used
Return values
parameterdescription
_accepted_idID to be used to retrieve the current import status or to stop the import procedure
_accepted_keya string representing the current import operation
_accepted_percpercentage of completion of the import (floating point number)
check_onlyecho back of the input parameter check_only
csv_has_headerecho back of the input parameter csv_has_header
csv_sepecho back of the input parameter csv_sep
domain_idecho back of the input parameter domain_id
errorsarray containing errors that occurred during the import (one element for each error)
importednumber of imported tracking links
project_idecho back of the input parameter project_id

/urls/info

access: [READ]

This method returns the info about a tracking link, returned fields are specified by parameter fields.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/info?fields=id,short_url&id=a8936d12c11e802ac731c89a46f8d37e

Query parameters

fields = id,short_url
    id = a8936d12c11e802ac731c89a46f8d37e

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": [
      {
        "id": "a8936d12c11e802ac731c89a46f8d37e",
        "short_url": "http:\/\/jo.my\/2280a888"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/info?fields=id,short_url&id=a8936d12c11e802ac731c89a46f8d37e&format=xml

Query parameters

fields = id,short_url
    id = a8936d12c11e802ac731c89a46f8d37e
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <i0>
        <id>a8936d12c11e802ac731c89a46f8d37e</id>  
        <short_url>http://jo.my/2280a888</short_url>  
      </i0>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/info?fields=id,short_url&id=a8936d12c11e802ac731c89a46f8d37e&format=txt

Query parameters

fields = id,short_url
    id = a8936d12c11e802ac731c89a46f8d37e
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_0_id=a8936d12c11e802ac731c89a46f8d37e
result_data_0_short_url=http://jo.my/2280a888

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/info?fields=id,short_url&id=a8936d12c11e802ac731c89a46f8d37e&format=plain

Query parameters

fields = id,short_url
    id = a8936d12c11e802ac731c89a46f8d37e
format = plain

Response

http://jo.my/2280a888
Required parameters
parameterdescription
fieldsARRAYcomma separated list of fields to return, see method i1/urls/list for reference
idIDID of the tracking link whose information is required
Return values
parameterdescription
dataarray containing 1 item on success, the returned information depends on the fields parameter.

/urls/instaurls

/urls/instaurls/clone

access: [WRITE]

Clone the InstaUrl configuration from a tracking link to another.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/instaurls/clone?from_url_id=4598dd7b8da22d21eac6a39b50a19eff&to_url_id=3ec1f5c2e4bc547916ae1df114a52c6a

Query parameters

from_url_id = 4598dd7b8da22d21eac6a39b50a19eff
  to_url_id = 3ec1f5c2e4bc547916ae1df114a52c6a

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "cloned": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/instaurls/clone?from_url_id=4598dd7b8da22d21eac6a39b50a19eff&to_url_id=3ec1f5c2e4bc547916ae1df114a52c6a&format=xml

Query parameters

from_url_id = 4598dd7b8da22d21eac6a39b50a19eff
  to_url_id = 3ec1f5c2e4bc547916ae1df114a52c6a
     format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <cloned>1</cloned>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/instaurls/clone?from_url_id=4598dd7b8da22d21eac6a39b50a19eff&to_url_id=3ec1f5c2e4bc547916ae1df114a52c6a&format=txt

Query parameters

from_url_id = 4598dd7b8da22d21eac6a39b50a19eff
  to_url_id = 3ec1f5c2e4bc547916ae1df114a52c6a
     format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_cloned=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/instaurls/clone?from_url_id=4598dd7b8da22d21eac6a39b50a19eff&to_url_id=3ec1f5c2e4bc547916ae1df114a52c6a&format=plain

Query parameters

from_url_id = 4598dd7b8da22d21eac6a39b50a19eff
  to_url_id = 3ec1f5c2e4bc547916ae1df114a52c6a
     format = plain

Response

1
Required parameters
parameterdescription
from_url_idIDID of the tracking link you want to copy the InstaUrl configuration from
to_url_idIDID of the tracking link you want to the InstaUrl configuration to
Return values
parameterdescription
cloned1 on success, 0 otherwise

/urls/instaurls/delete

access: [WRITE]

Delete InstaUrl settings for a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/instaurls/delete?id=5ae8268fc396c27c1f9ac19163738d52

Query parameters

id = 5ae8268fc396c27c1f9ac19163738d52

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/instaurls/delete?id=5ae8268fc396c27c1f9ac19163738d52&format=xml

Query parameters

    id = 5ae8268fc396c27c1f9ac19163738d52
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/instaurls/delete?id=5ae8268fc396c27c1f9ac19163738d52&format=txt

Query parameters

    id = 5ae8268fc396c27c1f9ac19163738d52
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/instaurls/delete?id=5ae8268fc396c27c1f9ac19163738d52&format=plain

Query parameters

    id = 5ae8268fc396c27c1f9ac19163738d52
format = plain

Response

1
Required parameters
parameterdescription
idIDID of the tracking link from which to remove an InstaUrl configuration
Return values
parameterdescription
deleted1 on success, 0 otherwise

/urls/instaurls/icons

/urls/instaurls/icons/info

access: [READ]

This method returns info on a SVG icon for InstaUrl.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/instaurls/icons/info?id=8ddaf293501f253b98f12554b2109203

Query parameters

id = 8ddaf293501f253b98f12554b2109203

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "8ddaf293501f253b98f12554b2109203",
    "svg": "<svg>[...]<\/svg>"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/instaurls/icons/info?id=8ddaf293501f253b98f12554b2109203&format=xml

Query parameters

    id = 8ddaf293501f253b98f12554b2109203
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>8ddaf293501f253b98f12554b2109203</id>  
    <svg><[CDATA[&lt;svg&gt;[...]&lt;/svg&gt;]]></svg>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/instaurls/icons/info?id=8ddaf293501f253b98f12554b2109203&format=txt

Query parameters

    id = 8ddaf293501f253b98f12554b2109203
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=8ddaf293501f253b98f12554b2109203
result_svg=&lt;svg&gt;[...]&lt;/svg&gt;

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/instaurls/icons/info?id=8ddaf293501f253b98f12554b2109203&format=plain

Query parameters

    id = 8ddaf293501f253b98f12554b2109203
format = plain

Response

8ddaf293501f253b98f12554b2109203
&lt;svg&gt;[...]&lt;/svg&gt;
Required parameters
parameterdescription
idSTRINGID of the icon as returned by the i1/urls/instaurls/icons/list method
Return values
parameterdescription
svgSVG of the requested icon
/urls/instaurls/icons/list

access: [READ]

This method returns a list of SVG icons for InstaUrl.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/instaurls/icons/list

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 1177,
    "icons": {
      "id": "6324c28af815c9623a51ab16d79404de",
      "svg": "<svg>[...]<\/svg>"
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/instaurls/icons/list?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>1177</count>  
    <icons>
      <id>6324c28af815c9623a51ab16d79404de</id>  
      <svg><[CDATA[&lt;svg&gt;[...]&lt;/svg&gt;]]></svg>  
    </icons>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/instaurls/icons/list?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=1177
result_icons_id=6324c28af815c9623a51ab16d79404de
result_icons_svg=&lt;svg&gt;[...]&lt;/svg&gt;

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/instaurls/icons/list?format=plain

Query parameters

format = plain

Response

1177
6324c28af815c9623a51ab16d79404de
&lt;svg&gt;[...]&lt;/svg&gt;
Optional parameters
parameterdescription
lengthINTEGERextracts this number of items (maxmimum allowed: 100)
searchSTRINGfilters items to be extracted by searching them
startINTEGERstarts to extract items from this position
Return values
parameterdescription
counttotal number of icons
iconsarray containing icons in the format {"id":"[id of the icon]","svg":"[SVG of the icon"}

/urls/jotbars

/urls/jotbars/clone

access: [WRITE]

Clone the jotbar configuration from a tracking link to another.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/jotbars/clone?from_url_id=ab091beb564b8259fe74717effd059a7&to_url_id=63917fffa78486c1193bba329c01ed19

Query parameters

from_url_id = ab091beb564b8259fe74717effd059a7
  to_url_id = 63917fffa78486c1193bba329c01ed19

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "cloned": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/jotbars/clone?from_url_id=ab091beb564b8259fe74717effd059a7&to_url_id=63917fffa78486c1193bba329c01ed19&format=xml

Query parameters

from_url_id = ab091beb564b8259fe74717effd059a7
  to_url_id = 63917fffa78486c1193bba329c01ed19
     format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <cloned>1</cloned>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/jotbars/clone?from_url_id=ab091beb564b8259fe74717effd059a7&to_url_id=63917fffa78486c1193bba329c01ed19&format=txt

Query parameters

from_url_id = ab091beb564b8259fe74717effd059a7
  to_url_id = 63917fffa78486c1193bba329c01ed19
     format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_cloned=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/jotbars/clone?from_url_id=ab091beb564b8259fe74717effd059a7&to_url_id=63917fffa78486c1193bba329c01ed19&format=plain

Query parameters

from_url_id = ab091beb564b8259fe74717effd059a7
  to_url_id = 63917fffa78486c1193bba329c01ed19
     format = plain

Response

1
Required parameters
parameterdescription
from_url_idIDID of the tracking link you want to copy the jotbar configuration from
to_url_idIDID of the tracking link you want to the jotbar configuration to
Return values
parameterdescription
cloned1 on success, 0 otherwise

/urls/jotbars/delete

access: [WRITE]

Remove a jotbar option for a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/jotbars/delete?id=a804babfa689a15003548c1fe37fc59e

Query parameters

id = a804babfa689a15003548c1fe37fc59e

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/jotbars/delete?id=a804babfa689a15003548c1fe37fc59e&format=xml

Query parameters

    id = a804babfa689a15003548c1fe37fc59e
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/jotbars/delete?id=a804babfa689a15003548c1fe37fc59e&format=txt

Query parameters

    id = a804babfa689a15003548c1fe37fc59e
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/jotbars/delete?id=a804babfa689a15003548c1fe37fc59e&format=plain

Query parameters

    id = a804babfa689a15003548c1fe37fc59e
format = plain

Response

1
Required parameters
parameterdescription
idIDID of the tracking link from which to remove a jotbar configuration
Return values
parameterdescription
deleted1 on success, 0 otherwise

/urls/jotbars/edit

access: [WRITE]

Set a jotbar option for a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/jotbars/edit?id=0cec53ffe9600c6c6f8d27976db90ff4&logo=https%3A%2F%2Fjoturl.com%2Flogo.svg&logo_url=https%3A%2F%2Fjoturl.com%2F&template=right&template_size=big&languages=en,it&default_language=&user_default_language=en&info=%7B%22en%22%3A%7B%22page_title%22%3A%22English+page+title%22,%22description_title%22%3Anull,%22description%22%3A%22%3Cp%3E%5BEN%5D+HTML+description%3C%5C%2Fp%3E%22,%22questions_title%22%3Anull,%22questions%22%3A%22%3Cp%3E%5BEN%5D+HTML+questions%3C%5C%2Fp%3E%22%7D,%22it%22%3A%7B%22page_title%22%3A%22Titolo+pagina+in+italiano%22,%22description_title%22%3Anull,%22description%22%3A%22%3Cp%3E%5BIT%5D+HTML+description%3C%5C%2Fp%3E%22,%22questions_title%22%3Anull,%22questions%22%3A%22%3Cp%3E%5BIT%5D+HTML+questions%3C%5C%2Fp%3E%22%7D%7D

Query parameters

                   id = 0cec53ffe9600c6c6f8d27976db90ff4
                 logo = https://joturl.com/logo.svg
             logo_url = https://joturl.com/
             template = right
        template_size = big
            languages = en,it
     default_language = 
user_default_language = en
                 info = {"en":{"page_title":"English page title","description_title":null,"description":"<p>[EN] HTML description<\/p>","questions_title":null,"questions":"<p>[EN] HTML questions<\/p>"},"it":{"page_title":"Titolo pagina in italiano","description_title":null,"description":"<p>[IT] HTML description<\/p>","questions_title":null,"questions":"<p>[IT] HTML questions<\/p>"}}

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "updated": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/jotbars/edit?id=0cec53ffe9600c6c6f8d27976db90ff4&logo=https%3A%2F%2Fjoturl.com%2Flogo.svg&logo_url=https%3A%2F%2Fjoturl.com%2F&template=right&template_size=big&languages=en,it&default_language=&user_default_language=en&info=%7B%22en%22%3A%7B%22page_title%22%3A%22English+page+title%22,%22description_title%22%3Anull,%22description%22%3A%22%3Cp%3E%5BEN%5D+HTML+description%3C%5C%2Fp%3E%22,%22questions_title%22%3Anull,%22questions%22%3A%22%3Cp%3E%5BEN%5D+HTML+questions%3C%5C%2Fp%3E%22%7D,%22it%22%3A%7B%22page_title%22%3A%22Titolo+pagina+in+italiano%22,%22description_title%22%3Anull,%22description%22%3A%22%3Cp%3E%5BIT%5D+HTML+description%3C%5C%2Fp%3E%22,%22questions_title%22%3Anull,%22questions%22%3A%22%3Cp%3E%5BIT%5D+HTML+questions%3C%5C%2Fp%3E%22%7D%7D&format=xml

Query parameters

                   id = 0cec53ffe9600c6c6f8d27976db90ff4
                 logo = https://joturl.com/logo.svg
             logo_url = https://joturl.com/
             template = right
        template_size = big
            languages = en,it
     default_language = 
user_default_language = en
                 info = {"en":{"page_title":"English page title","description_title":null,"description":"<p>[EN] HTML description<\/p>","questions_title":null,"questions":"<p>[EN] HTML questions<\/p>"},"it":{"page_title":"Titolo pagina in italiano","description_title":null,"description":"<p>[IT] HTML description<\/p>","questions_title":null,"questions":"<p>[IT] HTML questions<\/p>"}}
               format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <updated>1</updated>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/jotbars/edit?id=0cec53ffe9600c6c6f8d27976db90ff4&logo=https%3A%2F%2Fjoturl.com%2Flogo.svg&logo_url=https%3A%2F%2Fjoturl.com%2F&template=right&template_size=big&languages=en,it&default_language=&user_default_language=en&info=%7B%22en%22%3A%7B%22page_title%22%3A%22English+page+title%22,%22description_title%22%3Anull,%22description%22%3A%22%3Cp%3E%5BEN%5D+HTML+description%3C%5C%2Fp%3E%22,%22questions_title%22%3Anull,%22questions%22%3A%22%3Cp%3E%5BEN%5D+HTML+questions%3C%5C%2Fp%3E%22%7D,%22it%22%3A%7B%22page_title%22%3A%22Titolo+pagina+in+italiano%22,%22description_title%22%3Anull,%22description%22%3A%22%3Cp%3E%5BIT%5D+HTML+description%3C%5C%2Fp%3E%22,%22questions_title%22%3Anull,%22questions%22%3A%22%3Cp%3E%5BIT%5D+HTML+questions%3C%5C%2Fp%3E%22%7D%7D&format=txt

Query parameters

                   id = 0cec53ffe9600c6c6f8d27976db90ff4
                 logo = https://joturl.com/logo.svg
             logo_url = https://joturl.com/
             template = right
        template_size = big
            languages = en,it
     default_language = 
user_default_language = en
                 info = {"en":{"page_title":"English page title","description_title":null,"description":"<p>[EN] HTML description<\/p>","questions_title":null,"questions":"<p>[EN] HTML questions<\/p>"},"it":{"page_title":"Titolo pagina in italiano","description_title":null,"description":"<p>[IT] HTML description<\/p>","questions_title":null,"questions":"<p>[IT] HTML questions<\/p>"}}
               format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_updated=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/jotbars/edit?id=0cec53ffe9600c6c6f8d27976db90ff4&logo=https%3A%2F%2Fjoturl.com%2Flogo.svg&logo_url=https%3A%2F%2Fjoturl.com%2F&template=right&template_size=big&languages=en,it&default_language=&user_default_language=en&info=%7B%22en%22%3A%7B%22page_title%22%3A%22English+page+title%22,%22description_title%22%3Anull,%22description%22%3A%22%3Cp%3E%5BEN%5D+HTML+description%3C%5C%2Fp%3E%22,%22questions_title%22%3Anull,%22questions%22%3A%22%3Cp%3E%5BEN%5D+HTML+questions%3C%5C%2Fp%3E%22%7D,%22it%22%3A%7B%22page_title%22%3A%22Titolo+pagina+in+italiano%22,%22description_title%22%3Anull,%22description%22%3A%22%3Cp%3E%5BIT%5D+HTML+description%3C%5C%2Fp%3E%22,%22questions_title%22%3Anull,%22questions%22%3A%22%3Cp%3E%5BIT%5D+HTML+questions%3C%5C%2Fp%3E%22%7D%7D&format=plain

Query parameters

                   id = 0cec53ffe9600c6c6f8d27976db90ff4
                 logo = https://joturl.com/logo.svg
             logo_url = https://joturl.com/
             template = right
        template_size = big
            languages = en,it
     default_language = 
user_default_language = en
                 info = {"en":{"page_title":"English page title","description_title":null,"description":"<p>[EN] HTML description<\/p>","questions_title":null,"questions":"<p>[EN] HTML questions<\/p>"},"it":{"page_title":"Titolo pagina in italiano","description_title":null,"description":"<p>[IT] HTML description<\/p>","questions_title":null,"questions":"<p>[IT] HTML questions<\/p>"}}
               format = plain

Response

1
Required parameters
parameterdescription
idIDID of the project
Optional parameters
parameterdescription
embed_codeHTMLembed code for videos (for example the YouTube embedding code <iframe ...></iframe>), if available
infoJSONJSON containing page_title, description_title, description, questions_title, questions for each language in languages, see i1/urls/jotbars/info for details on info
logoSTRING0 to disable logo, the URL of the logo to be shown, empty or null to inherit the configuration from the account-level settings
logo_urlSTRINGwhen logo has an URL, this is the URL to which the user will be redirect when clicks on the logo
show_feedbackSTRING1 to show feedback, 0 to do not show it, empty or null to inherit the configuration from the account-level settings
templateSTRINGposition of the jotbar, empty or null to inherit the configuration from the account-level settings, for available positions see i1/jotbars/property
template_sizeSTRINGdimension of the jotbar, empty or null to inherit the configuration from the account-level settings,for available dimensions see i1/jotbars/property
video_durationSTRINGit represents the duration of the video in embed_code, if available
Return values
parameterdescription
dataNA

/urls/jotbars/info

access: [READ]

Get jotbar information of a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/jotbars/info?id=806e92475b0b7839aef9c2069806aed4

Query parameters

id = 806e92475b0b7839aef9c2069806aed4

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "logo": "https:\/\/joturl.com\/logo.svg",
    "logo_url": "https:\/\/joturl.com\/",
    "template": "right",
    "template_size": "big",
    "show_feedback": null,
    "embed_code": null,
    "video_duration": null,
    "info": {
      "en": {
        "page_title": "English page title",
        "description_title": null,
        "description": "<p>[EN] HTML description<\/p>",
        "questions_title": null,
        "questions": "<p>[EN] HTML questions<\/p>"
      },
      "it": {
        "page_title": "Titolo pagina in italiano",
        "description_title": null,
        "description": "<p>[IT] HTML description<\/p>",
        "questions_title": null,
        "questions": "<p>[IT] HTML questions<\/p>"
      }
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/jotbars/info?id=806e92475b0b7839aef9c2069806aed4&format=xml

Query parameters

    id = 806e92475b0b7839aef9c2069806aed4
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <logo>https://joturl.com/logo.svg</logo>  
    <logo_url>https://joturl.com/</logo_url>  
    <template>right</template>  
    <template_size>big</template_size>  
    <show_feedback></show_feedback>  
    <embed_code></embed_code>  
    <video_duration></video_duration>  
    <info>
      <en>
        <page_title>English page title</page_title>  
        <description_title></description_title>  
        <description><[CDATA[&lt;p&gt;[EN] HTML description&lt;/p&gt;]]></description>  
        <questions_title></questions_title>  
        <questions><[CDATA[&lt;p&gt;[EN] HTML questions&lt;/p&gt;]]></questions>  
      </en>  
      <it>
        <page_title>Titolo pagina in italiano</page_title>  
        <description_title></description_title>  
        <description><[CDATA[&lt;p&gt;[IT] HTML description&lt;/p&gt;]]></description>  
        <questions_title></questions_title>  
        <questions><[CDATA[&lt;p&gt;[IT] HTML questions&lt;/p&gt;]]></questions>  
      </it>  
    </info>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/jotbars/info?id=806e92475b0b7839aef9c2069806aed4&format=txt

Query parameters

    id = 806e92475b0b7839aef9c2069806aed4
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_logo=https://joturl.com/logo.svg
result_logo_url=https://joturl.com/
result_template=right
result_template_size=big
result_show_feedback=
result_embed_code=
result_video_duration=
result_info_en_page_title=English page title
result_info_en_description_title=
result_info_en_description=&lt;p&gt;[EN] HTML description&lt;/p&gt;
result_info_en_questions_title=
result_info_en_questions=&lt;p&gt;[EN] HTML questions&lt;/p&gt;
result_info_it_page_title=Titolo pagina in italiano
result_info_it_description_title=
result_info_it_description=&lt;p&gt;[IT] HTML description&lt;/p&gt;
result_info_it_questions_title=
result_info_it_questions=&lt;p&gt;[IT] HTML questions&lt;/p&gt;

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/jotbars/info?id=806e92475b0b7839aef9c2069806aed4&format=plain

Query parameters

    id = 806e92475b0b7839aef9c2069806aed4
format = plain

Response

https://joturl.com/logo.svg
https://joturl.com/
right
big



English page title

&lt;p&gt;[EN] HTML description&lt;/p&gt;

&lt;p&gt;[EN] HTML questions&lt;/p&gt;
Titolo pagina in italiano

&lt;p&gt;[IT] HTML description&lt;/p&gt;

&lt;p&gt;[IT] HTML questions&lt;/p&gt;
Required parameters
parameterdescription
idIDID of the tracking link
Return values
parameterdescription
embed_codeembed code for videos (for example the YouTube embedding code <iframe ...></iframe>), if available
infofor each language in languages, it contains page_title, description_title, description, questions_title, questions, see the following notes for details
logo0 to disable logo, the URL of the logo to be shown, empty or null to inherit the configuration from the account-level settings
logo_urlwhen logo has an URL, this is the URL to which the user will be redirect when clicks on the logo
show_feedback1 to show feedback, 0 to do not show it, empty or null to inherit the configuration from the account-level settings
templateposition of the jotbar, for available positions see i1/jotbars/property
template_sizedimension of the jotbar, for available dimensions see i1/jotbars/property
video_durationit represents the duration of the video in embed_code, if available

/urls/languages

/urls/languages/list

access: [READ]

This method returns a list of available languages for specific options (e.g., Masking, jotBar) of a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/languages/list?id=05e5ec05156632307d7e49c5f77eb6ed

Query parameters

id = 05e5ec05156632307d7e49c5f77eb6ed

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": [
    {
      "name": "en",
      "label": "English"
    },
    {
      "name": "it",
      "label": "Italiano"
    }
  ]
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/languages/list?id=05e5ec05156632307d7e49c5f77eb6ed&format=xml

Query parameters

    id = 05e5ec05156632307d7e49c5f77eb6ed
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <i0>
      <name>en</name>  
      <label>English</label>  
    </i0>  
    <i1>
      <name>it</name>  
      <label>Italiano</label>  
    </i1>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/languages/list?id=05e5ec05156632307d7e49c5f77eb6ed&format=txt

Query parameters

    id = 05e5ec05156632307d7e49c5f77eb6ed
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_0_name=en
result_0_label=English
result_1_name=it
result_1_label=Italiano

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/languages/list?id=05e5ec05156632307d7e49c5f77eb6ed&format=plain

Query parameters

    id = 05e5ec05156632307d7e49c5f77eb6ed
format = plain

Response

en
English
it
Italiano
Required parameters
parameterdescription
idIDID of the tracking link
Return values
parameterdescription
[ARRAY]array containing available languages

/urls/last

access: [READ]

This method returns the list of the last 100 tracking links strictly created by the logged user. Returned fields are that specified in the parameter fields.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/last?fields=id,short_url,creation

Query parameters

fields = id,short_url,creation

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": [
      {
        "creation": "2025-06-27 16:53:15",
        "id": "eecfdab6e9c45d614ac7c90c8e37f0ae",
        "short_url": "http:\/\/jo.my\/51f5c0d1"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/last?fields=id,short_url,creation&format=xml

Query parameters

fields = id,short_url,creation
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <i0>
        <creation>2025-06-27 16:53:15</creation>  
        <id>eecfdab6e9c45d614ac7c90c8e37f0ae</id>  
        <short_url>http://jo.my/51f5c0d1</short_url>  
      </i0>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/last?fields=id,short_url,creation&format=txt

Query parameters

fields = id,short_url,creation
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_0_creation=2025-06-27 16:53:15
result_data_0_id=eecfdab6e9c45d614ac7c90c8e37f0ae
result_data_0_short_url=http://jo.my/51f5c0d1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/last?fields=id,short_url,creation&format=plain

Query parameters

fields = id,short_url,creation
format = plain

Response

http://jo.my/51f5c0d1
Required parameters
parameterdescription
fieldsARRAYsee method i1/urls/list for reference
Optional parameters
parameterdescription
end_dateDATEsee method i1/urls/list for reference
filterSTRINGsee method i1/urls/list for reference
is_tracking_pixelBOOLEANsee method i1/urls/list for reference
lengthINTEGERsee method i1/urls/list for reference
optionSTRINGsee method i1/urls/list for reference
orderbyARRAYorders items by field (see method i1/urls/list for reference). Default is orderby = creation
project_idIDID of the project, if empty or unspecified, this method returns last-created tracking links for the whole account
searchSTRINGsee method i1/urls/list for reference
sortSTRINGsorts items in ascending (ASC) or descending (DESC) order. Default is sort = DESC
startINTEGERsee method i1/urls/list for reference
start_dateDATEsee method i1/urls/list for reference
whereSTRINGsee method i1/urls/list for reference
with_alertsBOOLEANsee method i1/urls/list for reference
Return values
parameterdescription
countsee method i1/urls/list for reference
datasee method i1/urls/list for reference

/urls/list

access: [READ]

This method returns a list of tracking links' data, returned fields are specified by parameter fields.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/list?fields=id,short_url&project_id=73dc1ae163d73a2163710109368981fc

Query parameters

    fields = id,short_url
project_id = 73dc1ae163d73a2163710109368981fc

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": [
      {
        "id": "1cc24533e7d0ee9e4c5f69801a3eba1d",
        "short_url": "http:\/\/jo.my\/20a0b7d7"
      },
      {
        "id": "2459ac25fed8b9577c53ff754e6a7b56",
        "short_url": "http:\/\/jo.my\/33cdb5ad"
      },
      {
        "id": "acef82615b98a0e4cc02c1c834efda9a",
        "short_url": "http:\/\/jo.my\/1edc86ab"
      },
      {
        "id": "cdff1414f54768642eb6ba768605f9ae",
        "short_url": "http:\/\/jo.my\/ec2d3ccf"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/list?fields=id,short_url&project_id=73dc1ae163d73a2163710109368981fc&format=xml

Query parameters

    fields = id,short_url
project_id = 73dc1ae163d73a2163710109368981fc
    format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <i0>
        <id>1cc24533e7d0ee9e4c5f69801a3eba1d</id>  
        <short_url>http://jo.my/20a0b7d7</short_url>  
      </i0>  
      <i1>
        <id>2459ac25fed8b9577c53ff754e6a7b56</id>  
        <short_url>http://jo.my/33cdb5ad</short_url>  
      </i1>  
      <i2>
        <id>acef82615b98a0e4cc02c1c834efda9a</id>  
        <short_url>http://jo.my/1edc86ab</short_url>  
      </i2>  
      <i3>
        <id>cdff1414f54768642eb6ba768605f9ae</id>  
        <short_url>http://jo.my/ec2d3ccf</short_url>  
      </i3>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/list?fields=id,short_url&project_id=73dc1ae163d73a2163710109368981fc&format=txt

Query parameters

    fields = id,short_url
project_id = 73dc1ae163d73a2163710109368981fc
    format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_0_id=1cc24533e7d0ee9e4c5f69801a3eba1d
result_data_0_short_url=http://jo.my/20a0b7d7
result_data_1_id=2459ac25fed8b9577c53ff754e6a7b56
result_data_1_short_url=http://jo.my/33cdb5ad
result_data_2_id=acef82615b98a0e4cc02c1c834efda9a
result_data_2_short_url=http://jo.my/1edc86ab
result_data_3_id=cdff1414f54768642eb6ba768605f9ae
result_data_3_short_url=http://jo.my/ec2d3ccf

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/list?fields=id,short_url&project_id=73dc1ae163d73a2163710109368981fc&format=plain

Query parameters

    fields = id,short_url
project_id = 73dc1ae163d73a2163710109368981fc
    format = plain

Response

http://jo.my/20a0b7d7
http://jo.my/33cdb5ad
http://jo.my/1edc86ab
http://jo.my/ec2d3ccf
Required parameters
parameterdescription
fieldsARRAYcomma separated list of fields to return, available fields: count, id, short_url, creation, url_tags, visits, unique_visits, qrcodes_visits, conversions_visits, long_url, notes, alias, options, is_tracking_pixel, project_id, project_name, domain_id, domain_host, domain_nickname
Optional parameters
parameterdescription
end_dateDATEfilter tracking links created up to this date (inclusive)
filterSTRINGfilter tracking links based on specific criteria, see notes for available filters
is_tracking_pixelBOOLEAN1 to return only tracking pixels, 0 to return only tracking links, do not pass this parameter to return both
lengthINTEGERextracts this number of items (maxmimum allowed: 100)
optionSTRINGfilter tracking links by option, see i1/urls/options/list for a list of available options
orderbyARRAYorders items by field, available fields: count, id, short_url, creation, url_tags, visits, unique_visits, qrcodes_visits, conversions_visits, long_url, notes, alias, options, is_tracking_pixel, project_id, project_name, domain_id, domain_host, domain_nickname
project_idIDID of the project, if empty or unspecified, the default project will be assumed
searchSTRINGfilters items to be extracted by searching them
sortSTRINGsorts items in ascending (ASC) or descending (DESC) order
startINTEGERstarts to extract items from this position
start_dateDATEfilter tracking links created from this date (inclusive)
whereSTRINGto be used in conjunction with search, specifies where to search and it can be [alias,domain,destination,notes,tags,utms];
with_alertsBOOLEANfilter tracking links with security alerts
Return values
parameterdescription
count[OPTIONAL] total number of tracking links, returned only if count is passed in fields
dataarray containing information on the tracking links, the returned information depends on the fields parameter.

/urls/masking

/urls/masking/clone

access: [WRITE]

Clone the masking configuration from a tracking link to another.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/masking/clone?from_url_id=141ae16aaaec99d66eb9b4d096ee5c06&to_url_id=2c0a9729a9f55cc4ff77d13a7d2a538f

Query parameters

from_url_id = 141ae16aaaec99d66eb9b4d096ee5c06
  to_url_id = 2c0a9729a9f55cc4ff77d13a7d2a538f

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "cloned": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/masking/clone?from_url_id=141ae16aaaec99d66eb9b4d096ee5c06&to_url_id=2c0a9729a9f55cc4ff77d13a7d2a538f&format=xml

Query parameters

from_url_id = 141ae16aaaec99d66eb9b4d096ee5c06
  to_url_id = 2c0a9729a9f55cc4ff77d13a7d2a538f
     format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <cloned>1</cloned>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/masking/clone?from_url_id=141ae16aaaec99d66eb9b4d096ee5c06&to_url_id=2c0a9729a9f55cc4ff77d13a7d2a538f&format=txt

Query parameters

from_url_id = 141ae16aaaec99d66eb9b4d096ee5c06
  to_url_id = 2c0a9729a9f55cc4ff77d13a7d2a538f
     format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_cloned=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/masking/clone?from_url_id=141ae16aaaec99d66eb9b4d096ee5c06&to_url_id=2c0a9729a9f55cc4ff77d13a7d2a538f&format=plain

Query parameters

from_url_id = 141ae16aaaec99d66eb9b4d096ee5c06
  to_url_id = 2c0a9729a9f55cc4ff77d13a7d2a538f
     format = plain

Response

1
Required parameters
parameterdescription
from_url_idIDID of the tracking link you want to copy the masking configuration from
to_url_idIDID of the tracking link you want to copy the masking configuration to
Return values
parameterdescription
cloned1 on success, 0 otherwise

/urls/masking/delete

access: [WRITE]

Delete the masking option from a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/masking/delete?id=f627dc4438ff0048b741b9e32cc11bcc

Query parameters

id = f627dc4438ff0048b741b9e32cc11bcc

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/masking/delete?id=f627dc4438ff0048b741b9e32cc11bcc&format=xml

Query parameters

    id = f627dc4438ff0048b741b9e32cc11bcc
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/masking/delete?id=f627dc4438ff0048b741b9e32cc11bcc&format=txt

Query parameters

    id = f627dc4438ff0048b741b9e32cc11bcc
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/masking/delete?id=f627dc4438ff0048b741b9e32cc11bcc&format=plain

Query parameters

    id = f627dc4438ff0048b741b9e32cc11bcc
format = plain

Response

1
Required parameters
parameterdescription
idIDID of the tracking link from which to remove a Masking configuration
Return values
parameterdescription
deleted1 on success, 0 otherwise

/urls/masking/edit

access: [WRITE]

Set a masking option for a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/masking/edit?id=421f84705fa989c1d14fb73957e33f9a&titles%5Ben%5D=This+is+title+for+the+page+in+English&titles%5Bit%5D=Questo+%C3%A8+un+titolo+per+la+pagina+in+Italiano&obfuscated=1&favicon=https%3A%2F%2Fwww.joturl.com%2Ffavicon.ico&otc_enabled=1&otc_validity=50&otc_private_key=3719114823

Query parameters

             id = 421f84705fa989c1d14fb73957e33f9a
     titles[en] = This is title for the page in English
     titles[it] = Questo è un titolo per la pagina in Italiano
     obfuscated = 1
        favicon = https://www.joturl.com/favicon.ico
    otc_enabled = 1
   otc_validity = 50
otc_private_key = 3719114823

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "enabled": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/masking/edit?id=421f84705fa989c1d14fb73957e33f9a&titles%5Ben%5D=This+is+title+for+the+page+in+English&titles%5Bit%5D=Questo+%C3%A8+un+titolo+per+la+pagina+in+Italiano&obfuscated=1&favicon=https%3A%2F%2Fwww.joturl.com%2Ffavicon.ico&otc_enabled=1&otc_validity=50&otc_private_key=3719114823&format=xml

Query parameters

             id = 421f84705fa989c1d14fb73957e33f9a
     titles[en] = This is title for the page in English
     titles[it] = Questo è un titolo per la pagina in Italiano
     obfuscated = 1
        favicon = https://www.joturl.com/favicon.ico
    otc_enabled = 1
   otc_validity = 50
otc_private_key = 3719114823
         format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <enabled>1</enabled>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/masking/edit?id=421f84705fa989c1d14fb73957e33f9a&titles%5Ben%5D=This+is+title+for+the+page+in+English&titles%5Bit%5D=Questo+%C3%A8+un+titolo+per+la+pagina+in+Italiano&obfuscated=1&favicon=https%3A%2F%2Fwww.joturl.com%2Ffavicon.ico&otc_enabled=1&otc_validity=50&otc_private_key=3719114823&format=txt

Query parameters

             id = 421f84705fa989c1d14fb73957e33f9a
     titles[en] = This is title for the page in English
     titles[it] = Questo è un titolo per la pagina in Italiano
     obfuscated = 1
        favicon = https://www.joturl.com/favicon.ico
    otc_enabled = 1
   otc_validity = 50
otc_private_key = 3719114823
         format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_enabled=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/masking/edit?id=421f84705fa989c1d14fb73957e33f9a&titles%5Ben%5D=This+is+title+for+the+page+in+English&titles%5Bit%5D=Questo+%C3%A8+un+titolo+per+la+pagina+in+Italiano&obfuscated=1&favicon=https%3A%2F%2Fwww.joturl.com%2Ffavicon.ico&otc_enabled=1&otc_validity=50&otc_private_key=3719114823&format=plain

Query parameters

             id = 421f84705fa989c1d14fb73957e33f9a
     titles[en] = This is title for the page in English
     titles[it] = Questo è un titolo per la pagina in Italiano
     obfuscated = 1
        favicon = https://www.joturl.com/favicon.ico
    otc_enabled = 1
   otc_validity = 50
otc_private_key = 3719114823
         format = plain

Response

1
Required parameters
parameterdescription
idIDID of the tracking link
Optional parameters
parameterdescriptionmax length
faviconURLcomplete URL for the favicon to be used, this URL must be in HTTPS to avoid securiy issues4000
obfuscatedBOOLEAN1 if the destiantion URL should be obfuscated, 0 otherwise
otc_enabledBOOLEAN1 to enable one-time code feature, 0 otherwise
otc_validityINTEGERthe time in seconds that the one-time code remains valid, too short times can cause malfunctions, too long times can give other users access to the one-time code. Available times: 10, 20, 30, 40, 50, 60, 180, 360, 540, 720, 1440, 2880, 4320, 5760, 7200, 8640, 10080
titlesJSONtitles for the masking page, one for each supported language; it contains couples (language codes, title), each title can contain maximum 500 characters500
Return values
parameterdescription
enabled1 on success, 0 otherwise

/urls/masking/info

access: [READ]

Get masking information for a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/masking/info?id=8bf64c68828d891ec8287fd5dc7d8430

Query parameters

id = 8bf64c68828d891ec8287fd5dc7d8430

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "titles": {
      "en": "This is title for the page in English",
      "it": "Questo è un titolo per la pagina in Italiano"
    },
    "obfuscated": 1,
    "favicon": "https:\/\/www.joturl.com\/favicon.ico",
    "otc_enabled": 1,
    "otc_validity": 50,
    "otc_private_key": "1211204524"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/masking/info?id=8bf64c68828d891ec8287fd5dc7d8430&format=xml

Query parameters

    id = 8bf64c68828d891ec8287fd5dc7d8430
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <titles>
      <en>This is title for the page in English</en>  
      <it><[CDATA[Questo &egrave; un titolo per la pagina in Italiano]]></it>  
    </titles>  
    <obfuscated>1</obfuscated>  
    <favicon>https://www.joturl.com/favicon.ico</favicon>  
    <otc_enabled>1</otc_enabled>  
    <otc_validity>50</otc_validity>  
    <otc_private_key>1211204524</otc_private_key>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/masking/info?id=8bf64c68828d891ec8287fd5dc7d8430&format=txt

Query parameters

    id = 8bf64c68828d891ec8287fd5dc7d8430
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_titles_en=This is title for the page in English
result_titles_it=Questo &egrave; un titolo per la pagina in Italiano
result_obfuscated=1
result_favicon=https://www.joturl.com/favicon.ico
result_otc_enabled=1
result_otc_validity=50
result_otc_private_key=1211204524

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/masking/info?id=8bf64c68828d891ec8287fd5dc7d8430&format=plain

Query parameters

    id = 8bf64c68828d891ec8287fd5dc7d8430
format = plain

Response

This is title for the page in English
Questo &egrave; un titolo per la pagina in Italiano
1
https://www.joturl.com/favicon.ico
1
50
1211204524
Required parameters
parameterdescription
idIDID of the tracking link
Return values
parameterdescription
favicon[OPTIONAL] complete URL for the favicon to be used, this URL must be in HTTPS to avoid securiy issues
obfuscated[OPTIONAL] 1 if the destiantion URL should be obfuscated, 0 otherwise
otc_enabled[OPTIONAL] 1 if the one-time code feature is enabled, 0 otherwise
otc_private_key[OPTIONAL] one-time code private key, it is the key to be used to generate one-time codes
otc_validity[OPTIONAL] the time in seconds that the one-time code remains valid, see i1/urls/masking/edit for details
titles[OPTIONAL] titles for the masking page, one for each supported language

/urls/minipages

/urls/minipages/clone

access: [WRITE]

Clone the minpages configuration from a tracking link to another.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/minipages/clone?from_url_id=35104cab7acfc62bba80b9df9fc8349f&to_url_id=636e98d59480e5c6cf288278f122db71

Query parameters

from_url_id = 35104cab7acfc62bba80b9df9fc8349f
  to_url_id = 636e98d59480e5c6cf288278f122db71

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "cloned": 0
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/minipages/clone?from_url_id=35104cab7acfc62bba80b9df9fc8349f&to_url_id=636e98d59480e5c6cf288278f122db71&format=xml

Query parameters

from_url_id = 35104cab7acfc62bba80b9df9fc8349f
  to_url_id = 636e98d59480e5c6cf288278f122db71
     format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <cloned>0</cloned>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/minipages/clone?from_url_id=35104cab7acfc62bba80b9df9fc8349f&to_url_id=636e98d59480e5c6cf288278f122db71&format=txt

Query parameters

from_url_id = 35104cab7acfc62bba80b9df9fc8349f
  to_url_id = 636e98d59480e5c6cf288278f122db71
     format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_cloned=0

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/minipages/clone?from_url_id=35104cab7acfc62bba80b9df9fc8349f&to_url_id=636e98d59480e5c6cf288278f122db71&format=plain

Query parameters

from_url_id = 35104cab7acfc62bba80b9df9fc8349f
  to_url_id = 636e98d59480e5c6cf288278f122db71
     format = plain

Response

0
Required parameters
parameterdescription
from_url_idIDID of the tracking link you want to copy the minpages configuration from
to_url_idIDID of the tracking link you want to the minpages configuration to
Return values
parameterdescription
cloned1 on success, 0 otherwise

/urls/minipages/delete

access: [WRITE]

Unset (delete) a minipage for a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/minipages/delete?id=63547106500e24edb7e173f5b1328745

Query parameters

id = 63547106500e24edb7e173f5b1328745

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/minipages/delete?id=63547106500e24edb7e173f5b1328745&format=xml

Query parameters

    id = 63547106500e24edb7e173f5b1328745
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/minipages/delete?id=63547106500e24edb7e173f5b1328745&format=txt

Query parameters

    id = 63547106500e24edb7e173f5b1328745
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/minipages/delete?id=63547106500e24edb7e173f5b1328745&format=plain

Query parameters

    id = 63547106500e24edb7e173f5b1328745
format = plain

Response

1
Required parameters
parameterdescription
idIDID of the tracking link from which to remove a Minipage configuration
Return values
parameterdescription
deleted1 on success, 0 otherwise

/urls/move

access: [WRITE]

Moves a tracking link from a project to another.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/move?src_project_id=b6d09682314c93fe4ad3c34bee8f2364&dst_project_id=c31cd9eb0233c998e5d682c4d826d8c6&id=35c1be6dc19f280fafcfb18f5a5ca6eb

Query parameters

src_project_id = b6d09682314c93fe4ad3c34bee8f2364
dst_project_id = c31cd9eb0233c998e5d682c4d826d8c6
            id = 35c1be6dc19f280fafcfb18f5a5ca6eb

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "moved": [
      {
        "src_project_id": "b6d09682314c93fe4ad3c34bee8f2364",
        "id": "35c1be6dc19f280fafcfb18f5a5ca6eb"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/move?src_project_id=b6d09682314c93fe4ad3c34bee8f2364&dst_project_id=c31cd9eb0233c998e5d682c4d826d8c6&id=35c1be6dc19f280fafcfb18f5a5ca6eb&format=xml

Query parameters

src_project_id = b6d09682314c93fe4ad3c34bee8f2364
dst_project_id = c31cd9eb0233c998e5d682c4d826d8c6
            id = 35c1be6dc19f280fafcfb18f5a5ca6eb
        format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <moved>
      <i0>
        <src_project_id>b6d09682314c93fe4ad3c34bee8f2364</src_project_id>  
        <id>35c1be6dc19f280fafcfb18f5a5ca6eb</id>  
      </i0>  
    </moved>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/move?src_project_id=b6d09682314c93fe4ad3c34bee8f2364&dst_project_id=c31cd9eb0233c998e5d682c4d826d8c6&id=35c1be6dc19f280fafcfb18f5a5ca6eb&format=txt

Query parameters

src_project_id = b6d09682314c93fe4ad3c34bee8f2364
dst_project_id = c31cd9eb0233c998e5d682c4d826d8c6
            id = 35c1be6dc19f280fafcfb18f5a5ca6eb
        format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_moved_0_src_project_id=b6d09682314c93fe4ad3c34bee8f2364
result_moved_0_id=35c1be6dc19f280fafcfb18f5a5ca6eb

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/move?src_project_id=b6d09682314c93fe4ad3c34bee8f2364&dst_project_id=c31cd9eb0233c998e5d682c4d826d8c6&id=35c1be6dc19f280fafcfb18f5a5ca6eb&format=plain

Query parameters

src_project_id = b6d09682314c93fe4ad3c34bee8f2364
dst_project_id = c31cd9eb0233c998e5d682c4d826d8c6
            id = 35c1be6dc19f280fafcfb18f5a5ca6eb
        format = plain

Response

b6d09682314c93fe4ad3c34bee8f2364
35c1be6dc19f280fafcfb18f5a5ca6eb
Required parameters
parameterdescription
dst_project_idIDID of the project the tracking link have to be moved to
src_project_idIDID of the project the tracking link is currently in
Optional parameters
parameterdescription
fieldsARRAYsee method i1/urls/list for a list of available fields
idIDID of the tracking link to move
idsARRAY_OF_IDScomma separated list of tracking link IDs to be moved
Return values
parameterdescription
movedarray containing information on the moved tracking links, errors occurred while moving are ignored and this array can be empty. The information returned depends on the fields parameter. If fields is not passed, IDs of the tracking links and of the source project are returned. See method i1/urls/list for a list of return fields.

/urls/options

/urls/options/check

access: [READ]

Checks if an option is compatible with those active on the tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/options/check?id=3333e5b5d0653bd2f9cfe0de66014746&option=easydeeplink

Query parameters

    id = 3333e5b5d0653bd2f9cfe0de66014746
option = easydeeplink

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "compatible": 0,
    "incompatible": "split"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/options/check?id=3333e5b5d0653bd2f9cfe0de66014746&option=easydeeplink&format=xml

Query parameters

    id = 3333e5b5d0653bd2f9cfe0de66014746
option = easydeeplink
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <compatible>0</compatible>  
    <incompatible>split</incompatible>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/options/check?id=3333e5b5d0653bd2f9cfe0de66014746&option=easydeeplink&format=txt

Query parameters

    id = 3333e5b5d0653bd2f9cfe0de66014746
option = easydeeplink
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_compatible=0
result_incompatible=split

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/options/check?id=3333e5b5d0653bd2f9cfe0de66014746&option=easydeeplink&format=plain

Query parameters

    id = 3333e5b5d0653bd2f9cfe0de66014746
option = easydeeplink
format = plain

Response

0
split
Required parameters
parameterdescription
idIDID of the tracking link
optionSTRINGOption to be checked
Return values
parameterdescription
compatible1 if the option is compatible with the options that are active on the tracking link, 0 otherwise
incompatibleif compatible = 0, it contains the option that is not compatible with the passed option, if compatible = 1 it is empty. incompatible is not a list of all incompatible options, but just the first option detected

/urls/options/info

access: [READ]

Returns the list of available options for a specific TLs. Further, this method returns the exclusion list (options that cannot be used with other options), the list of options that are disabled for the user plan and the list of options that can be used to filter tracking links.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/options/info?id=797293

Query parameters

id = 797293

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "options": [
      "balancer",
      "cloaking",
      "conversions",
      "ctas",
      "deeplink",
      "easydeeplink",
      "instaurl",
      "jotbar",
      "masking",
      "minipage",
      "parameters",
      "preview",
      "redirector",
      "remarketings",
      "selfdestruction",
      "split",
      "whatsapp"
    ],
    "exclusions": {
      "balancer": [
        "ctas",
        "deeplink",
        "easydeeplink",
        "instaurl",
        "jotbar",
        "masking",
        "minipage",
        "redirector",
        "remarketings",
        "split",
        "whatsapp"
      ],
      "cloaking": [],
      "conversions": [
        "split"
      ],
      "ctas": [
        "balancer",
        "deeplink",
        "easydeeplink",
        "instaurl",
        "jotbar",
        "masking",
        "minipage",
        "redirector",
        "split",
        "whatsapp"
      ],
      "deeplink": [
        "balancer",
        "ctas",
        "easydeeplink",
        "instaurl",
        "jotbar",
        "masking",
        "minipage",
        "redirector",
        "remarketings",
        "split",
        "whatsapp"
      ],
      "easydeeplink": [
        "balancer",
        "ctas",
        "deeplink",
        "instaurl",
        "jotbar",
        "masking",
        "minipage",
        "redirector",
        "remarketings",
        "split",
        "whatsapp"
      ],
      "instaurl": [
        "balancer",
        "ctas",
        "deeplink",
        "easydeeplink",
        "jotbar",
        "masking",
        "minipage",
        "redirector",
        "split",
        "whatsapp"
      ],
      "jotbar": [
        "balancer",
        "ctas",
        "deeplink",
        "easydeeplink",
        "instaurl",
        "masking",
        "minipage",
        "redirector",
        "split",
        "whatsapp"
      ],
      "masking": [
        "balancer",
        "ctas",
        "deeplink",
        "easydeeplink",
        "instaurl",
        "jotbar",
        "minipage",
        "redirector",
        "split",
        "whatsapp"
      ],
      "minipage": [
        "balancer",
        "ctas",
        "deeplink",
        "easydeeplink",
        "instaurl",
        "jotbar",
        "masking",
        "redirector",
        "split",
        "whatsapp"
      ],
      "parameters": [],
      "preview": [],
      "redirector": [
        "balancer",
        "ctas",
        "deeplink",
        "easydeeplink",
        "instaurl",
        "jotbar",
        "masking",
        "minipage",
        "remarketings",
        "split",
        "whatsapp"
      ],
      "remarketings": [
        "balancer",
        "deeplink",
        "easydeeplink",
        "redirector",
        "split",
        "whatsapp"
      ],
      "selfdestruction": [],
      "split": [
        "balancer",
        "conversions",
        "ctas",
        "deeplink",
        "easydeeplink",
        "instaurl",
        "jotbar",
        "masking",
        "minipage",
        "redirector",
        "remarketings",
        "whatsapp"
      ],
      "whatsapp": [
        "balancer",
        "ctas",
        "deeplink",
        "easydeeplink",
        "instaurl",
        "jotbar",
        "masking",
        "minipage",
        "redirector",
        "remarketings",
        "split"
      ]
    },
    "disabled": [],
    "filters": [
      "balancer",
      "cloaking",
      "conversions",
      "ctas",
      "deeplink",
      "easydeeplink",
      "instaurl",
      "jotbar",
      "masking",
      "minipage",
      "parameters",
      "preview",
      "redirector",
      "remarketings",
      "selfdestruction",
      "split",
      "whatsapp"
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/options/info?id=797293&format=xml

Query parameters

    id = 797293
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <options>
      <i0>balancer</i0>  
      <i1>cloaking</i1>  
      <i2>conversions</i2>  
      <i3>ctas</i3>  
      <i4>deeplink</i4>  
      <i5>easydeeplink</i5>  
      <i6>instaurl</i6>  
      <i7>jotbar</i7>  
      <i8>masking</i8>  
      <i9>minipage</i9>  
      <i10>parameters</i10>  
      <i11>preview</i11>  
      <i12>redirector</i12>  
      <i13>remarketings</i13>  
      <i14>selfdestruction</i14>  
      <i15>split</i15>  
      <i16>whatsapp</i16>  
    </options>  
    <exclusions>
      <balancer>
        <i0>ctas</i0>  
        <i1>deeplink</i1>  
        <i2>easydeeplink</i2>  
        <i3>instaurl</i3>  
        <i4>jotbar</i4>  
        <i5>masking</i5>  
        <i6>minipage</i6>  
        <i7>redirector</i7>  
        <i8>remarketings</i8>  
        <i9>split</i9>  
        <i10>whatsapp</i10>  
      </balancer>  
      <cloaking>

      </cloaking>  
      <conversions>
        <i0>split</i0>  
      </conversions>  
      <ctas>
        <i0>balancer</i0>  
        <i1>deeplink</i1>  
        <i2>easydeeplink</i2>  
        <i3>instaurl</i3>  
        <i4>jotbar</i4>  
        <i5>masking</i5>  
        <i6>minipage</i6>  
        <i7>redirector</i7>  
        <i8>split</i8>  
        <i9>whatsapp</i9>  
      </ctas>  
      <deeplink>
        <i0>balancer</i0>  
        <i1>ctas</i1>  
        <i2>easydeeplink</i2>  
        <i3>instaurl</i3>  
        <i4>jotbar</i4>  
        <i5>masking</i5>  
        <i6>minipage</i6>  
        <i7>redirector</i7>  
        <i8>remarketings</i8>  
        <i9>split</i9>  
        <i10>whatsapp</i10>  
      </deeplink>  
      <easydeeplink>
        <i0>balancer</i0>  
        <i1>ctas</i1>  
        <i2>deeplink</i2>  
        <i3>instaurl</i3>  
        <i4>jotbar</i4>  
        <i5>masking</i5>  
        <i6>minipage</i6>  
        <i7>redirector</i7>  
        <i8>remarketings</i8>  
        <i9>split</i9>  
        <i10>whatsapp</i10>  
      </easydeeplink>  
      <instaurl>
        <i0>balancer</i0>  
        <i1>ctas</i1>  
        <i2>deeplink</i2>  
        <i3>easydeeplink</i3>  
        <i4>jotbar</i4>  
        <i5>masking</i5>  
        <i6>minipage</i6>  
        <i7>redirector</i7>  
        <i8>split</i8>  
        <i9>whatsapp</i9>  
      </instaurl>  
      <jotbar>
        <i0>balancer</i0>  
        <i1>ctas</i1>  
        <i2>deeplink</i2>  
        <i3>easydeeplink</i3>  
        <i4>instaurl</i4>  
        <i5>masking</i5>  
        <i6>minipage</i6>  
        <i7>redirector</i7>  
        <i8>split</i8>  
        <i9>whatsapp</i9>  
      </jotbar>  
      <masking>
        <i0>balancer</i0>  
        <i1>ctas</i1>  
        <i2>deeplink</i2>  
        <i3>easydeeplink</i3>  
        <i4>instaurl</i4>  
        <i5>jotbar</i5>  
        <i6>minipage</i6>  
        <i7>redirector</i7>  
        <i8>split</i8>  
        <i9>whatsapp</i9>  
      </masking>  
      <minipage>
        <i0>balancer</i0>  
        <i1>ctas</i1>  
        <i2>deeplink</i2>  
        <i3>easydeeplink</i3>  
        <i4>instaurl</i4>  
        <i5>jotbar</i5>  
        <i6>masking</i6>  
        <i7>redirector</i7>  
        <i8>split</i8>  
        <i9>whatsapp</i9>  
      </minipage>  
      <parameters>

      </parameters>  
      <preview>

      </preview>  
      <redirector>
        <i0>balancer</i0>  
        <i1>ctas</i1>  
        <i2>deeplink</i2>  
        <i3>easydeeplink</i3>  
        <i4>instaurl</i4>  
        <i5>jotbar</i5>  
        <i6>masking</i6>  
        <i7>minipage</i7>  
        <i8>remarketings</i8>  
        <i9>split</i9>  
        <i10>whatsapp</i10>  
      </redirector>  
      <remarketings>
        <i0>balancer</i0>  
        <i1>deeplink</i1>  
        <i2>easydeeplink</i2>  
        <i3>redirector</i3>  
        <i4>split</i4>  
        <i5>whatsapp</i5>  
      </remarketings>  
      <selfdestruction>

      </selfdestruction>  
      <split>
        <i0>balancer</i0>  
        <i1>conversions</i1>  
        <i2>ctas</i2>  
        <i3>deeplink</i3>  
        <i4>easydeeplink</i4>  
        <i5>instaurl</i5>  
        <i6>jotbar</i6>  
        <i7>masking</i7>  
        <i8>minipage</i8>  
        <i9>redirector</i9>  
        <i10>remarketings</i10>  
        <i11>whatsapp</i11>  
      </split>  
      <whatsapp>
        <i0>balancer</i0>  
        <i1>ctas</i1>  
        <i2>deeplink</i2>  
        <i3>easydeeplink</i3>  
        <i4>instaurl</i4>  
        <i5>jotbar</i5>  
        <i6>masking</i6>  
        <i7>minipage</i7>  
        <i8>redirector</i8>  
        <i9>remarketings</i9>  
        <i10>split</i10>  
      </whatsapp>  
    </exclusions>  
    <disabled>

    </disabled>  
    <filters>
      <i0>balancer</i0>  
      <i1>cloaking</i1>  
      <i2>conversions</i2>  
      <i3>ctas</i3>  
      <i4>deeplink</i4>  
      <i5>easydeeplink</i5>  
      <i6>instaurl</i6>  
      <i7>jotbar</i7>  
      <i8>masking</i8>  
      <i9>minipage</i9>  
      <i10>parameters</i10>  
      <i11>preview</i11>  
      <i12>redirector</i12>  
      <i13>remarketings</i13>  
      <i14>selfdestruction</i14>  
      <i15>split</i15>  
      <i16>whatsapp</i16>  
    </filters>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/options/info?id=797293&format=txt

Query parameters

    id = 797293
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_options_0=balancer
result_options_1=cloaking
result_options_2=conversions
result_options_3=ctas
result_options_4=deeplink
result_options_5=easydeeplink
result_options_6=instaurl
result_options_7=jotbar
result_options_8=masking
result_options_9=minipage
result_options_10=parameters
result_options_11=preview
result_options_12=redirector
result_options_13=remarketings
result_options_14=selfdestruction
result_options_15=split
result_options_16=whatsapp
result_exclusions_balancer_0=ctas
result_exclusions_balancer_1=deeplink
result_exclusions_balancer_2=easydeeplink
result_exclusions_balancer_3=instaurl
result_exclusions_balancer_4=jotbar
result_exclusions_balancer_5=masking
result_exclusions_balancer_6=minipage
result_exclusions_balancer_7=redirector
result_exclusions_balancer_8=remarketings
result_exclusions_balancer_9=split
result_exclusions_balancer_10=whatsapp
result_exclusions_cloaking=
result_exclusions_conversions_0=split
result_exclusions_ctas_0=balancer
result_exclusions_ctas_1=deeplink
result_exclusions_ctas_2=easydeeplink
result_exclusions_ctas_3=instaurl
result_exclusions_ctas_4=jotbar
result_exclusions_ctas_5=masking
result_exclusions_ctas_6=minipage
result_exclusions_ctas_7=redirector
result_exclusions_ctas_8=split
result_exclusions_ctas_9=whatsapp
result_exclusions_deeplink_0=balancer
result_exclusions_deeplink_1=ctas
result_exclusions_deeplink_2=easydeeplink
result_exclusions_deeplink_3=instaurl
result_exclusions_deeplink_4=jotbar
result_exclusions_deeplink_5=masking
result_exclusions_deeplink_6=minipage
result_exclusions_deeplink_7=redirector
result_exclusions_deeplink_8=remarketings
result_exclusions_deeplink_9=split
result_exclusions_deeplink_10=whatsapp
result_exclusions_easydeeplink_0=balancer
result_exclusions_easydeeplink_1=ctas
result_exclusions_easydeeplink_2=deeplink
result_exclusions_easydeeplink_3=instaurl
result_exclusions_easydeeplink_4=jotbar
result_exclusions_easydeeplink_5=masking
result_exclusions_easydeeplink_6=minipage
result_exclusions_easydeeplink_7=redirector
result_exclusions_easydeeplink_8=remarketings
result_exclusions_easydeeplink_9=split
result_exclusions_easydeeplink_10=whatsapp
result_exclusions_instaurl_0=balancer
result_exclusions_instaurl_1=ctas
result_exclusions_instaurl_2=deeplink
result_exclusions_instaurl_3=easydeeplink
result_exclusions_instaurl_4=jotbar
result_exclusions_instaurl_5=masking
result_exclusions_instaurl_6=minipage
result_exclusions_instaurl_7=redirector
result_exclusions_instaurl_8=split
result_exclusions_instaurl_9=whatsapp
result_exclusions_jotbar_0=balancer
result_exclusions_jotbar_1=ctas
result_exclusions_jotbar_2=deeplink
result_exclusions_jotbar_3=easydeeplink
result_exclusions_jotbar_4=instaurl
result_exclusions_jotbar_5=masking
result_exclusions_jotbar_6=minipage
result_exclusions_jotbar_7=redirector
result_exclusions_jotbar_8=split
result_exclusions_jotbar_9=whatsapp
result_exclusions_masking_0=balancer
result_exclusions_masking_1=ctas
result_exclusions_masking_2=deeplink
result_exclusions_masking_3=easydeeplink
result_exclusions_masking_4=instaurl
result_exclusions_masking_5=jotbar
result_exclusions_masking_6=minipage
result_exclusions_masking_7=redirector
result_exclusions_masking_8=split
result_exclusions_masking_9=whatsapp
result_exclusions_minipage_0=balancer
result_exclusions_minipage_1=ctas
result_exclusions_minipage_2=deeplink
result_exclusions_minipage_3=easydeeplink
result_exclusions_minipage_4=instaurl
result_exclusions_minipage_5=jotbar
result_exclusions_minipage_6=masking
result_exclusions_minipage_7=redirector
result_exclusions_minipage_8=split
result_exclusions_minipage_9=whatsapp
result_exclusions_parameters=
result_exclusions_preview=
result_exclusions_redirector_0=balancer
result_exclusions_redirector_1=ctas
result_exclusions_redirector_2=deeplink
result_exclusions_redirector_3=easydeeplink
result_exclusions_redirector_4=instaurl
result_exclusions_redirector_5=jotbar
result_exclusions_redirector_6=masking
result_exclusions_redirector_7=minipage
result_exclusions_redirector_8=remarketings
result_exclusions_redirector_9=split
result_exclusions_redirector_10=whatsapp
result_exclusions_remarketings_0=balancer
result_exclusions_remarketings_1=deeplink
result_exclusions_remarketings_2=easydeeplink
result_exclusions_remarketings_3=redirector
result_exclusions_remarketings_4=split
result_exclusions_remarketings_5=whatsapp
result_exclusions_selfdestruction=
result_exclusions_split_0=balancer
result_exclusions_split_1=conversions
result_exclusions_split_2=ctas
result_exclusions_split_3=deeplink
result_exclusions_split_4=easydeeplink
result_exclusions_split_5=instaurl
result_exclusions_split_6=jotbar
result_exclusions_split_7=masking
result_exclusions_split_8=minipage
result_exclusions_split_9=redirector
result_exclusions_split_10=remarketings
result_exclusions_split_11=whatsapp
result_exclusions_whatsapp_0=balancer
result_exclusions_whatsapp_1=ctas
result_exclusions_whatsapp_2=deeplink
result_exclusions_whatsapp_3=easydeeplink
result_exclusions_whatsapp_4=instaurl
result_exclusions_whatsapp_5=jotbar
result_exclusions_whatsapp_6=masking
result_exclusions_whatsapp_7=minipage
result_exclusions_whatsapp_8=redirector
result_exclusions_whatsapp_9=remarketings
result_exclusions_whatsapp_10=split
result_disabled=
result_filters_0=balancer
result_filters_1=cloaking
result_filters_2=conversions
result_filters_3=ctas
result_filters_4=deeplink
result_filters_5=easydeeplink
result_filters_6=instaurl
result_filters_7=jotbar
result_filters_8=masking
result_filters_9=minipage
result_filters_10=parameters
result_filters_11=preview
result_filters_12=redirector
result_filters_13=remarketings
result_filters_14=selfdestruction
result_filters_15=split
result_filters_16=whatsapp

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/options/info?id=797293&format=plain

Query parameters

    id = 797293
format = plain

Response

balancer
cloaking
conversions
ctas
deeplink
easydeeplink
instaurl
jotbar
masking
minipage
parameters
preview
redirector
remarketings
selfdestruction
split
whatsapp
ctas
deeplink
easydeeplink
instaurl
jotbar
masking
minipage
redirector
remarketings
split
whatsapp

split
balancer
deeplink
easydeeplink
instaurl
jotbar
masking
minipage
redirector
split
whatsapp
balancer
ctas
easydeeplink
instaurl
jotbar
masking
minipage
redirector
remarketings
split
whatsapp
balancer
ctas
deeplink
instaurl
jotbar
masking
minipage
redirector
remarketings
split
whatsapp
balancer
ctas
deeplink
easydeeplink
jotbar
masking
minipage
redirector
split
whatsapp
balancer
ctas
deeplink
easydeeplink
instaurl
masking
minipage
redirector
split
whatsapp
balancer
ctas
deeplink
easydeeplink
instaurl
jotbar
minipage
redirector
split
whatsapp
balancer
ctas
deeplink
easydeeplink
instaurl
jotbar
masking
redirector
split
whatsapp


balancer
ctas
deeplink
easydeeplink
instaurl
jotbar
masking
minipage
remarketings
split
whatsapp
balancer
deeplink
easydeeplink
redirector
split
whatsapp

balancer
conversions
ctas
deeplink
easydeeplink
instaurl
jotbar
masking
minipage
redirector
remarketings
whatsapp
balancer
ctas
deeplink
easydeeplink
instaurl
jotbar
masking
minipage
redirector
remarketings
split

balancer
cloaking
conversions
ctas
deeplink
easydeeplink
instaurl
jotbar
masking
minipage
parameters
preview
redirector
remarketings
selfdestruction
split
whatsapp
Required parameters
parameterdescription
idIDID of the tracking link
Return values
parameterdescription
disabledList of options that are not available for the current user
exclusionsList of options that are not compatible with other options. Each option of the list contains an array of incompatible options
filtersList of options that are can be used to filter tracking links
optionsList of options available for the specified tracking link

/urls/options/list

access: [READ]

Returns the list of available options for TLs. Further, this method returns the exlusion list (options that cannot be used in conjuction of other options), the list of options that are disabled for the user plan and the list of options that can be used to filter tracking links.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/options/list

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "options": [
      "balancer",
      "cloaking",
      "conversions",
      "ctas",
      "deeplink",
      "easydeeplink",
      "instaurl",
      "jotbar",
      "masking",
      "minipage",
      "parameters",
      "preview",
      "redirector",
      "remarketings",
      "selfdestruction",
      "split",
      "whatsapp"
    ],
    "exclusions": {
      "balancer": [
        "ctas",
        "deeplink",
        "easydeeplink",
        "instaurl",
        "jotbar",
        "masking",
        "minipage",
        "redirector",
        "remarketings",
        "split",
        "whatsapp"
      ],
      "cloaking": [],
      "conversions": [
        "split"
      ],
      "ctas": [
        "balancer",
        "deeplink",
        "easydeeplink",
        "instaurl",
        "jotbar",
        "masking",
        "minipage",
        "redirector",
        "split",
        "whatsapp"
      ],
      "deeplink": [
        "balancer",
        "ctas",
        "easydeeplink",
        "instaurl",
        "jotbar",
        "masking",
        "minipage",
        "redirector",
        "remarketings",
        "split",
        "whatsapp"
      ],
      "easydeeplink": [
        "balancer",
        "ctas",
        "deeplink",
        "instaurl",
        "jotbar",
        "masking",
        "minipage",
        "redirector",
        "remarketings",
        "split",
        "whatsapp"
      ],
      "instaurl": [
        "balancer",
        "ctas",
        "deeplink",
        "easydeeplink",
        "jotbar",
        "masking",
        "minipage",
        "redirector",
        "split",
        "whatsapp"
      ],
      "jotbar": [
        "balancer",
        "ctas",
        "deeplink",
        "easydeeplink",
        "instaurl",
        "masking",
        "minipage",
        "redirector",
        "split",
        "whatsapp"
      ],
      "masking": [
        "balancer",
        "ctas",
        "deeplink",
        "easydeeplink",
        "instaurl",
        "jotbar",
        "minipage",
        "redirector",
        "split",
        "whatsapp"
      ],
      "minipage": [
        "balancer",
        "ctas",
        "deeplink",
        "easydeeplink",
        "instaurl",
        "jotbar",
        "masking",
        "redirector",
        "split",
        "whatsapp"
      ],
      "parameters": [],
      "preview": [],
      "redirector": [
        "balancer",
        "ctas",
        "deeplink",
        "easydeeplink",
        "instaurl",
        "jotbar",
        "masking",
        "minipage",
        "remarketings",
        "split",
        "whatsapp"
      ],
      "remarketings": [
        "balancer",
        "deeplink",
        "easydeeplink",
        "redirector",
        "split",
        "whatsapp"
      ],
      "selfdestruction": [],
      "split": [
        "balancer",
        "conversions",
        "ctas",
        "deeplink",
        "easydeeplink",
        "instaurl",
        "jotbar",
        "masking",
        "minipage",
        "redirector",
        "remarketings",
        "whatsapp"
      ],
      "whatsapp": [
        "balancer",
        "ctas",
        "deeplink",
        "easydeeplink",
        "instaurl",
        "jotbar",
        "masking",
        "minipage",
        "redirector",
        "remarketings",
        "split"
      ]
    },
    "disabled": [],
    "filters": [
      "balancer",
      "cloaking",
      "conversions",
      "ctas",
      "deeplink",
      "easydeeplink",
      "instaurl",
      "jotbar",
      "masking",
      "minipage",
      "parameters",
      "preview",
      "redirector",
      "remarketings",
      "selfdestruction",
      "split",
      "whatsapp"
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/options/list?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <options>
      <i0>balancer</i0>  
      <i1>cloaking</i1>  
      <i2>conversions</i2>  
      <i3>ctas</i3>  
      <i4>deeplink</i4>  
      <i5>easydeeplink</i5>  
      <i6>instaurl</i6>  
      <i7>jotbar</i7>  
      <i8>masking</i8>  
      <i9>minipage</i9>  
      <i10>parameters</i10>  
      <i11>preview</i11>  
      <i12>redirector</i12>  
      <i13>remarketings</i13>  
      <i14>selfdestruction</i14>  
      <i15>split</i15>  
      <i16>whatsapp</i16>  
    </options>  
    <exclusions>
      <balancer>
        <i0>ctas</i0>  
        <i1>deeplink</i1>  
        <i2>easydeeplink</i2>  
        <i3>instaurl</i3>  
        <i4>jotbar</i4>  
        <i5>masking</i5>  
        <i6>minipage</i6>  
        <i7>redirector</i7>  
        <i8>remarketings</i8>  
        <i9>split</i9>  
        <i10>whatsapp</i10>  
      </balancer>  
      <cloaking>

      </cloaking>  
      <conversions>
        <i0>split</i0>  
      </conversions>  
      <ctas>
        <i0>balancer</i0>  
        <i1>deeplink</i1>  
        <i2>easydeeplink</i2>  
        <i3>instaurl</i3>  
        <i4>jotbar</i4>  
        <i5>masking</i5>  
        <i6>minipage</i6>  
        <i7>redirector</i7>  
        <i8>split</i8>  
        <i9>whatsapp</i9>  
      </ctas>  
      <deeplink>
        <i0>balancer</i0>  
        <i1>ctas</i1>  
        <i2>easydeeplink</i2>  
        <i3>instaurl</i3>  
        <i4>jotbar</i4>  
        <i5>masking</i5>  
        <i6>minipage</i6>  
        <i7>redirector</i7>  
        <i8>remarketings</i8>  
        <i9>split</i9>  
        <i10>whatsapp</i10>  
      </deeplink>  
      <easydeeplink>
        <i0>balancer</i0>  
        <i1>ctas</i1>  
        <i2>deeplink</i2>  
        <i3>instaurl</i3>  
        <i4>jotbar</i4>  
        <i5>masking</i5>  
        <i6>minipage</i6>  
        <i7>redirector</i7>  
        <i8>remarketings</i8>  
        <i9>split</i9>  
        <i10>whatsapp</i10>  
      </easydeeplink>  
      <instaurl>
        <i0>balancer</i0>  
        <i1>ctas</i1>  
        <i2>deeplink</i2>  
        <i3>easydeeplink</i3>  
        <i4>jotbar</i4>  
        <i5>masking</i5>  
        <i6>minipage</i6>  
        <i7>redirector</i7>  
        <i8>split</i8>  
        <i9>whatsapp</i9>  
      </instaurl>  
      <jotbar>
        <i0>balancer</i0>  
        <i1>ctas</i1>  
        <i2>deeplink</i2>  
        <i3>easydeeplink</i3>  
        <i4>instaurl</i4>  
        <i5>masking</i5>  
        <i6>minipage</i6>  
        <i7>redirector</i7>  
        <i8>split</i8>  
        <i9>whatsapp</i9>  
      </jotbar>  
      <masking>
        <i0>balancer</i0>  
        <i1>ctas</i1>  
        <i2>deeplink</i2>  
        <i3>easydeeplink</i3>  
        <i4>instaurl</i4>  
        <i5>jotbar</i5>  
        <i6>minipage</i6>  
        <i7>redirector</i7>  
        <i8>split</i8>  
        <i9>whatsapp</i9>  
      </masking>  
      <minipage>
        <i0>balancer</i0>  
        <i1>ctas</i1>  
        <i2>deeplink</i2>  
        <i3>easydeeplink</i3>  
        <i4>instaurl</i4>  
        <i5>jotbar</i5>  
        <i6>masking</i6>  
        <i7>redirector</i7>  
        <i8>split</i8>  
        <i9>whatsapp</i9>  
      </minipage>  
      <parameters>

      </parameters>  
      <preview>

      </preview>  
      <redirector>
        <i0>balancer</i0>  
        <i1>ctas</i1>  
        <i2>deeplink</i2>  
        <i3>easydeeplink</i3>  
        <i4>instaurl</i4>  
        <i5>jotbar</i5>  
        <i6>masking</i6>  
        <i7>minipage</i7>  
        <i8>remarketings</i8>  
        <i9>split</i9>  
        <i10>whatsapp</i10>  
      </redirector>  
      <remarketings>
        <i0>balancer</i0>  
        <i1>deeplink</i1>  
        <i2>easydeeplink</i2>  
        <i3>redirector</i3>  
        <i4>split</i4>  
        <i5>whatsapp</i5>  
      </remarketings>  
      <selfdestruction>

      </selfdestruction>  
      <split>
        <i0>balancer</i0>  
        <i1>conversions</i1>  
        <i2>ctas</i2>  
        <i3>deeplink</i3>  
        <i4>easydeeplink</i4>  
        <i5>instaurl</i5>  
        <i6>jotbar</i6>  
        <i7>masking</i7>  
        <i8>minipage</i8>  
        <i9>redirector</i9>  
        <i10>remarketings</i10>  
        <i11>whatsapp</i11>  
      </split>  
      <whatsapp>
        <i0>balancer</i0>  
        <i1>ctas</i1>  
        <i2>deeplink</i2>  
        <i3>easydeeplink</i3>  
        <i4>instaurl</i4>  
        <i5>jotbar</i5>  
        <i6>masking</i6>  
        <i7>minipage</i7>  
        <i8>redirector</i8>  
        <i9>remarketings</i9>  
        <i10>split</i10>  
      </whatsapp>  
    </exclusions>  
    <disabled>

    </disabled>  
    <filters>
      <i0>balancer</i0>  
      <i1>cloaking</i1>  
      <i2>conversions</i2>  
      <i3>ctas</i3>  
      <i4>deeplink</i4>  
      <i5>easydeeplink</i5>  
      <i6>instaurl</i6>  
      <i7>jotbar</i7>  
      <i8>masking</i8>  
      <i9>minipage</i9>  
      <i10>parameters</i10>  
      <i11>preview</i11>  
      <i12>redirector</i12>  
      <i13>remarketings</i13>  
      <i14>selfdestruction</i14>  
      <i15>split</i15>  
      <i16>whatsapp</i16>  
    </filters>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/options/list?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_options_0=balancer
result_options_1=cloaking
result_options_2=conversions
result_options_3=ctas
result_options_4=deeplink
result_options_5=easydeeplink
result_options_6=instaurl
result_options_7=jotbar
result_options_8=masking
result_options_9=minipage
result_options_10=parameters
result_options_11=preview
result_options_12=redirector
result_options_13=remarketings
result_options_14=selfdestruction
result_options_15=split
result_options_16=whatsapp
result_exclusions_balancer_0=ctas
result_exclusions_balancer_1=deeplink
result_exclusions_balancer_2=easydeeplink
result_exclusions_balancer_3=instaurl
result_exclusions_balancer_4=jotbar
result_exclusions_balancer_5=masking
result_exclusions_balancer_6=minipage
result_exclusions_balancer_7=redirector
result_exclusions_balancer_8=remarketings
result_exclusions_balancer_9=split
result_exclusions_balancer_10=whatsapp
result_exclusions_cloaking=
result_exclusions_conversions_0=split
result_exclusions_ctas_0=balancer
result_exclusions_ctas_1=deeplink
result_exclusions_ctas_2=easydeeplink
result_exclusions_ctas_3=instaurl
result_exclusions_ctas_4=jotbar
result_exclusions_ctas_5=masking
result_exclusions_ctas_6=minipage
result_exclusions_ctas_7=redirector
result_exclusions_ctas_8=split
result_exclusions_ctas_9=whatsapp
result_exclusions_deeplink_0=balancer
result_exclusions_deeplink_1=ctas
result_exclusions_deeplink_2=easydeeplink
result_exclusions_deeplink_3=instaurl
result_exclusions_deeplink_4=jotbar
result_exclusions_deeplink_5=masking
result_exclusions_deeplink_6=minipage
result_exclusions_deeplink_7=redirector
result_exclusions_deeplink_8=remarketings
result_exclusions_deeplink_9=split
result_exclusions_deeplink_10=whatsapp
result_exclusions_easydeeplink_0=balancer
result_exclusions_easydeeplink_1=ctas
result_exclusions_easydeeplink_2=deeplink
result_exclusions_easydeeplink_3=instaurl
result_exclusions_easydeeplink_4=jotbar
result_exclusions_easydeeplink_5=masking
result_exclusions_easydeeplink_6=minipage
result_exclusions_easydeeplink_7=redirector
result_exclusions_easydeeplink_8=remarketings
result_exclusions_easydeeplink_9=split
result_exclusions_easydeeplink_10=whatsapp
result_exclusions_instaurl_0=balancer
result_exclusions_instaurl_1=ctas
result_exclusions_instaurl_2=deeplink
result_exclusions_instaurl_3=easydeeplink
result_exclusions_instaurl_4=jotbar
result_exclusions_instaurl_5=masking
result_exclusions_instaurl_6=minipage
result_exclusions_instaurl_7=redirector
result_exclusions_instaurl_8=split
result_exclusions_instaurl_9=whatsapp
result_exclusions_jotbar_0=balancer
result_exclusions_jotbar_1=ctas
result_exclusions_jotbar_2=deeplink
result_exclusions_jotbar_3=easydeeplink
result_exclusions_jotbar_4=instaurl
result_exclusions_jotbar_5=masking
result_exclusions_jotbar_6=minipage
result_exclusions_jotbar_7=redirector
result_exclusions_jotbar_8=split
result_exclusions_jotbar_9=whatsapp
result_exclusions_masking_0=balancer
result_exclusions_masking_1=ctas
result_exclusions_masking_2=deeplink
result_exclusions_masking_3=easydeeplink
result_exclusions_masking_4=instaurl
result_exclusions_masking_5=jotbar
result_exclusions_masking_6=minipage
result_exclusions_masking_7=redirector
result_exclusions_masking_8=split
result_exclusions_masking_9=whatsapp
result_exclusions_minipage_0=balancer
result_exclusions_minipage_1=ctas
result_exclusions_minipage_2=deeplink
result_exclusions_minipage_3=easydeeplink
result_exclusions_minipage_4=instaurl
result_exclusions_minipage_5=jotbar
result_exclusions_minipage_6=masking
result_exclusions_minipage_7=redirector
result_exclusions_minipage_8=split
result_exclusions_minipage_9=whatsapp
result_exclusions_parameters=
result_exclusions_preview=
result_exclusions_redirector_0=balancer
result_exclusions_redirector_1=ctas
result_exclusions_redirector_2=deeplink
result_exclusions_redirector_3=easydeeplink
result_exclusions_redirector_4=instaurl
result_exclusions_redirector_5=jotbar
result_exclusions_redirector_6=masking
result_exclusions_redirector_7=minipage
result_exclusions_redirector_8=remarketings
result_exclusions_redirector_9=split
result_exclusions_redirector_10=whatsapp
result_exclusions_remarketings_0=balancer
result_exclusions_remarketings_1=deeplink
result_exclusions_remarketings_2=easydeeplink
result_exclusions_remarketings_3=redirector
result_exclusions_remarketings_4=split
result_exclusions_remarketings_5=whatsapp
result_exclusions_selfdestruction=
result_exclusions_split_0=balancer
result_exclusions_split_1=conversions
result_exclusions_split_2=ctas
result_exclusions_split_3=deeplink
result_exclusions_split_4=easydeeplink
result_exclusions_split_5=instaurl
result_exclusions_split_6=jotbar
result_exclusions_split_7=masking
result_exclusions_split_8=minipage
result_exclusions_split_9=redirector
result_exclusions_split_10=remarketings
result_exclusions_split_11=whatsapp
result_exclusions_whatsapp_0=balancer
result_exclusions_whatsapp_1=ctas
result_exclusions_whatsapp_2=deeplink
result_exclusions_whatsapp_3=easydeeplink
result_exclusions_whatsapp_4=instaurl
result_exclusions_whatsapp_5=jotbar
result_exclusions_whatsapp_6=masking
result_exclusions_whatsapp_7=minipage
result_exclusions_whatsapp_8=redirector
result_exclusions_whatsapp_9=remarketings
result_exclusions_whatsapp_10=split
result_disabled=
result_filters_0=balancer
result_filters_1=cloaking
result_filters_2=conversions
result_filters_3=ctas
result_filters_4=deeplink
result_filters_5=easydeeplink
result_filters_6=instaurl
result_filters_7=jotbar
result_filters_8=masking
result_filters_9=minipage
result_filters_10=parameters
result_filters_11=preview
result_filters_12=redirector
result_filters_13=remarketings
result_filters_14=selfdestruction
result_filters_15=split
result_filters_16=whatsapp

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/options/list?format=plain

Query parameters

format = plain

Response

balancer
cloaking
conversions
ctas
deeplink
easydeeplink
instaurl
jotbar
masking
minipage
parameters
preview
redirector
remarketings
selfdestruction
split
whatsapp
ctas
deeplink
easydeeplink
instaurl
jotbar
masking
minipage
redirector
remarketings
split
whatsapp

split
balancer
deeplink
easydeeplink
instaurl
jotbar
masking
minipage
redirector
split
whatsapp
balancer
ctas
easydeeplink
instaurl
jotbar
masking
minipage
redirector
remarketings
split
whatsapp
balancer
ctas
deeplink
instaurl
jotbar
masking
minipage
redirector
remarketings
split
whatsapp
balancer
ctas
deeplink
easydeeplink
jotbar
masking
minipage
redirector
split
whatsapp
balancer
ctas
deeplink
easydeeplink
instaurl
masking
minipage
redirector
split
whatsapp
balancer
ctas
deeplink
easydeeplink
instaurl
jotbar
minipage
redirector
split
whatsapp
balancer
ctas
deeplink
easydeeplink
instaurl
jotbar
masking
redirector
split
whatsapp


balancer
ctas
deeplink
easydeeplink
instaurl
jotbar
masking
minipage
remarketings
split
whatsapp
balancer
deeplink
easydeeplink
redirector
split
whatsapp

balancer
conversions
ctas
deeplink
easydeeplink
instaurl
jotbar
masking
minipage
redirector
remarketings
whatsapp
balancer
ctas
deeplink
easydeeplink
instaurl
jotbar
masking
minipage
redirector
remarketings
split

balancer
cloaking
conversions
ctas
deeplink
easydeeplink
instaurl
jotbar
masking
minipage
parameters
preview
redirector
remarketings
selfdestruction
split
whatsapp
Return values
parameterdescription
disabledList of options that are not available for the current user
exclusionsList of options that are not compatible with other options. Each option of the list contains an array of incompatible options
filtersList of options that are can be used to filter tracking links
optionsList of options available for tracking links

/urls/parameters

/urls/parameters/clone

access: [WRITE]

Clone the UTM paramters from a tracking link to another.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/parameters/clone?from_url_id=cc8f9763ce0fa6e34b2b0169fc978264&to_url_id=07a2ba6bd531e5add669981b7fc53b99

Query parameters

from_url_id = cc8f9763ce0fa6e34b2b0169fc978264
  to_url_id = 07a2ba6bd531e5add669981b7fc53b99

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "cloned": 0
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/parameters/clone?from_url_id=cc8f9763ce0fa6e34b2b0169fc978264&to_url_id=07a2ba6bd531e5add669981b7fc53b99&format=xml

Query parameters

from_url_id = cc8f9763ce0fa6e34b2b0169fc978264
  to_url_id = 07a2ba6bd531e5add669981b7fc53b99
     format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <cloned>0</cloned>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/parameters/clone?from_url_id=cc8f9763ce0fa6e34b2b0169fc978264&to_url_id=07a2ba6bd531e5add669981b7fc53b99&format=txt

Query parameters

from_url_id = cc8f9763ce0fa6e34b2b0169fc978264
  to_url_id = 07a2ba6bd531e5add669981b7fc53b99
     format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_cloned=0

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/parameters/clone?from_url_id=cc8f9763ce0fa6e34b2b0169fc978264&to_url_id=07a2ba6bd531e5add669981b7fc53b99&format=plain

Query parameters

from_url_id = cc8f9763ce0fa6e34b2b0169fc978264
  to_url_id = 07a2ba6bd531e5add669981b7fc53b99
     format = plain

Response

0
Required parameters
parameterdescription
from_url_idIDID of the tracking link you want to copy the UTM paramters from
to_url_idIDID of the tracking link you want to copy the UTM paramters to
Return values
parameterdescription
cloned1 on success, 0 otherwise

/urls/parameters/delete

access: [WRITE]

Delete UTM parameters from the destination URL of a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/parameters/delete?url_id=7b070a2417ea38e186c146d9375c00b1

Query parameters

url_id = 7b070a2417ea38e186c146d9375c00b1

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/parameters/delete?url_id=7b070a2417ea38e186c146d9375c00b1&format=xml

Query parameters

url_id = 7b070a2417ea38e186c146d9375c00b1
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/parameters/delete?url_id=7b070a2417ea38e186c146d9375c00b1&format=txt

Query parameters

url_id = 7b070a2417ea38e186c146d9375c00b1
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/parameters/delete?url_id=7b070a2417ea38e186c146d9375c00b1&format=plain

Query parameters

url_id = 7b070a2417ea38e186c146d9375c00b1
format = plain

Response

1
Required parameters
parameterdescription
url_idIDID of the tracking link from which to remove the UTM parameters
Return values
parameterdescription
deleted1 on success, 0 otherwise

/urls/parameters/edit

access: [WRITE]

Set query and UTM parameters of the destination URL of a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/parameters/edit?url_id=06ea1f792e02d7f510efaba0b8700b63&utm_template_id=1654d2e55a850924434ac2260f0b6579¶ms%5Bp1%5D=v1¶ms%5Bp2%5D=v2

Query parameters

         url_id = 06ea1f792e02d7f510efaba0b8700b63
utm_template_id = 1654d2e55a850924434ac2260f0b6579
     params[p1] = v1
     params[p2] = v2

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "added": 1,
    "url_id": "06ea1f792e02d7f510efaba0b8700b63",
    "enabled": 1,
    "utm_template_id": "1654d2e55a850924434ac2260f0b6579",
    "utm_source": "",
    "utm_medium": "",
    "utm_campaign": "",
    "utm_term": "",
    "utm_content": "",
    "long_url": "https:\/\/www.joturl.com\/reserved\/projects.html?p1=v1&p2=v2"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/parameters/edit?url_id=06ea1f792e02d7f510efaba0b8700b63&utm_template_id=1654d2e55a850924434ac2260f0b6579¶ms%5Bp1%5D=v1¶ms%5Bp2%5D=v2&format=xml

Query parameters

         url_id = 06ea1f792e02d7f510efaba0b8700b63
utm_template_id = 1654d2e55a850924434ac2260f0b6579
     params[p1] = v1
     params[p2] = v2
         format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <added>1</added>  
    <url_id>06ea1f792e02d7f510efaba0b8700b63</url_id>  
    <enabled>1</enabled>  
    <utm_template_id>1654d2e55a850924434ac2260f0b6579</utm_template_id>  
    <utm_source></utm_source>  
    <utm_medium></utm_medium>  
    <utm_campaign></utm_campaign>  
    <utm_term></utm_term>  
    <utm_content></utm_content>  
    <long_url><[CDATA[https://www.joturl.com/reserved/projects.html?p1=v1&amp;p2=v2]]></long_url>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/parameters/edit?url_id=06ea1f792e02d7f510efaba0b8700b63&utm_template_id=1654d2e55a850924434ac2260f0b6579¶ms%5Bp1%5D=v1¶ms%5Bp2%5D=v2&format=txt

Query parameters

         url_id = 06ea1f792e02d7f510efaba0b8700b63
utm_template_id = 1654d2e55a850924434ac2260f0b6579
     params[p1] = v1
     params[p2] = v2
         format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_added=1
result_url_id=06ea1f792e02d7f510efaba0b8700b63
result_enabled=1
result_utm_template_id=1654d2e55a850924434ac2260f0b6579
result_utm_source=
result_utm_medium=
result_utm_campaign=
result_utm_term=
result_utm_content=
result_long_url=https://www.joturl.com/reserved/projects.html?p1=v1&amp;p2=v2

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/parameters/edit?url_id=06ea1f792e02d7f510efaba0b8700b63&utm_template_id=1654d2e55a850924434ac2260f0b6579¶ms%5Bp1%5D=v1¶ms%5Bp2%5D=v2&format=plain

Query parameters

         url_id = 06ea1f792e02d7f510efaba0b8700b63
utm_template_id = 1654d2e55a850924434ac2260f0b6579
     params[p1] = v1
     params[p2] = v2
         format = plain

Response

1
06ea1f792e02d7f510efaba0b8700b63
1
1654d2e55a850924434ac2260f0b6579





https://www.joturl.com/reserved/projects.html?p1=v1&amp;p2=v2
Required parameters
parameterdescription
url_idIDID of the tracking link
Optional parameters
parameterdescription
paramsJSONcouples (key,value) to be set in the destination URL of the tracking link, this only affects the main destination URL, other destination URLs coming from other options (e.g., balancer, timing) are not changed. Old parameters are deleted or changed with the passed values.
utm_campaignSTRINGUTM campaign parameter
utm_contentSTRINGUTM content parameter
utm_mediumSTRINGUTM medium parameter
utm_sourceSTRINGUTM source parameter
utm_template_idIDID of the UTM template to associate to the tracking link
utm_termSTRINGUTM term parameter
Return values
parameterdescription
added1 on success, 0 otherwise
enabled1 if UTM parameters have been set for the tracking link, 0 otherwise
long_url[OPTIONAL] returned only if input paramter params is passed
utm_campaignecho back of the input utm_campaign parameter if utm_template_id is not passed, empty otherwise
utm_contentecho back of the input utm_content parameter if utm_template_id is not passed, empty otherwise
utm_mediumecho back of the input utm_medium parameter if utm_template_id is not passed, empty otherwise
utm_sourceecho back of the input utm_source parameter if utm_template_id is not passed, empty otherwise
utm_template_idecho back of the input utm_template_id parameter
utm_termecho back of the input utm_term parameter if utm_template_id is not passed, empty otherwise

/urls/parameters/info

access: [READ]

Get query and UTM parameters of the destination URL of a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/parameters/info?url_id=1d6abe98373b7fe132e62406e5bd2c78

Query parameters

url_id = 1d6abe98373b7fe132e62406e5bd2c78

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "params": {
      "p1": "v1",
      "p2": "v2"
    },
    "utm_template_id": "8d600a33b9d50f14cd14da94c9903c0b",
    "name": "template name",
    "utm_source": "",
    "utm_medium": "",
    "utm_campaign": "",
    "utm_term": "",
    "utm_content": "",
    "long_url": "https:\/\/www.joturl.com\/reserved\/projects.html?p1=v1&p2=v2"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/parameters/info?url_id=1d6abe98373b7fe132e62406e5bd2c78&format=xml

Query parameters

url_id = 1d6abe98373b7fe132e62406e5bd2c78
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <params>
      <p1>v1</p1>  
      <p2>v2</p2>  
    </params>  
    <utm_template_id>8d600a33b9d50f14cd14da94c9903c0b</utm_template_id>  
    <name>template name</name>  
    <utm_source></utm_source>  
    <utm_medium></utm_medium>  
    <utm_campaign></utm_campaign>  
    <utm_term></utm_term>  
    <utm_content></utm_content>  
    <long_url><[CDATA[https://www.joturl.com/reserved/projects.html?p1=v1&amp;p2=v2]]></long_url>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/parameters/info?url_id=1d6abe98373b7fe132e62406e5bd2c78&format=txt

Query parameters

url_id = 1d6abe98373b7fe132e62406e5bd2c78
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_params_p1=v1
result_params_p2=v2
result_utm_template_id=8d600a33b9d50f14cd14da94c9903c0b
result_name=template name
result_utm_source=
result_utm_medium=
result_utm_campaign=
result_utm_term=
result_utm_content=
result_long_url=https://www.joturl.com/reserved/projects.html?p1=v1&amp;p2=v2

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/parameters/info?url_id=1d6abe98373b7fe132e62406e5bd2c78&format=plain

Query parameters

url_id = 1d6abe98373b7fe132e62406e5bd2c78
format = plain

Response

v1
v2
8d600a33b9d50f14cd14da94c9903c0b
template name





https://www.joturl.com/reserved/projects.html?p1=v1&amp;p2=v2
Required parameters
parameterdescription
url_idIDID of the tracking link
Return values
parameterdescription
long_urldestination URL of the tracking link
namename of the UTM template if utm_template_id is not empty
paramscouples (key,value) representing query parameters of the destination URL
utm_campaignutm_campaign parameter, it is the utm_campaign defined in the UTM template if utm_template_id is not empty, otherwise it is the custom utm_campaign defined in the tracking link (if available)
utm_contentutm_content parameter, it is the utm_content defined in the UTM template if utm_template_id is not empty, otherwise it is the custom utm_content defined in the tracking link (if available)
utm_mediumutm_medium parameter, it is the utm_medium defined in the UTM template if utm_template_id is not empty, otherwise it is the custom utm_medium defined in the tracking link (if available)
utm_sourceutm_source parameter, it is the utm_source defined in the UTM template if utm_template_id is not empty, otherwise it is the custom utm_source defined in the tracking link (if available)
utm_template_idID of the applied UTM template, if available
utm_termutm_term parameter, it is the utm_term defined in the UTM template if utm_template_id is not empty, otherwise it is the custom utm_term defined in the tracking link (if available)

/urls/password

/urls/password/clone

access: [WRITE]

Clone a password from a tracking link to another.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/password/clone?from_url_id=1f05a2c3b5a8e14d058b60f58862125a&to_url_id=9d57b30db052c9be22681d34f8f7cb4d

Query parameters

from_url_id = 1f05a2c3b5a8e14d058b60f58862125a
  to_url_id = 9d57b30db052c9be22681d34f8f7cb4d

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "cloned": 0
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/password/clone?from_url_id=1f05a2c3b5a8e14d058b60f58862125a&to_url_id=9d57b30db052c9be22681d34f8f7cb4d&format=xml

Query parameters

from_url_id = 1f05a2c3b5a8e14d058b60f58862125a
  to_url_id = 9d57b30db052c9be22681d34f8f7cb4d
     format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <cloned>0</cloned>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/password/clone?from_url_id=1f05a2c3b5a8e14d058b60f58862125a&to_url_id=9d57b30db052c9be22681d34f8f7cb4d&format=txt

Query parameters

from_url_id = 1f05a2c3b5a8e14d058b60f58862125a
  to_url_id = 9d57b30db052c9be22681d34f8f7cb4d
     format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_cloned=0

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/password/clone?from_url_id=1f05a2c3b5a8e14d058b60f58862125a&to_url_id=9d57b30db052c9be22681d34f8f7cb4d&format=plain

Query parameters

from_url_id = 1f05a2c3b5a8e14d058b60f58862125a
  to_url_id = 9d57b30db052c9be22681d34f8f7cb4d
     format = plain

Response

0
Required parameters
parameterdescription
from_url_idIDID of the tracking link you want to copy password from
to_url_idIDID of the tracking link you want to copy password to
Return values
parameterdescription
cloned1 on success, 0 otherwise (e.g., the password is empty)

/urls/password/delete

access: [WRITE]

Delete the password of a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/password/delete?id=9e13e8331b8ca4470bdd2d6a6f4517b3

Query parameters

id = 9e13e8331b8ca4470bdd2d6a6f4517b3

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/password/delete?id=9e13e8331b8ca4470bdd2d6a6f4517b3&format=xml

Query parameters

    id = 9e13e8331b8ca4470bdd2d6a6f4517b3
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/password/delete?id=9e13e8331b8ca4470bdd2d6a6f4517b3&format=txt

Query parameters

    id = 9e13e8331b8ca4470bdd2d6a6f4517b3
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/password/delete?id=9e13e8331b8ca4470bdd2d6a6f4517b3&format=plain

Query parameters

    id = 9e13e8331b8ca4470bdd2d6a6f4517b3
format = plain

Response

1
Required parameters
parameterdescription
idIDID of the tracking link from which to remove the password
Return values
parameterdescription
deleted1 on success, 0 otherwise

/urls/password/edit

access: [WRITE]

Define a password for the tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/password/edit?id=cc828c78c6fb9c16d31b7fc04dda963e&password=4ac1d54c

Query parameters

      id = cc828c78c6fb9c16d31b7fc04dda963e
password = 4ac1d54c

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "password": "4ac1d54c"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/password/edit?id=cc828c78c6fb9c16d31b7fc04dda963e&password=4ac1d54c&format=xml

Query parameters

      id = cc828c78c6fb9c16d31b7fc04dda963e
password = 4ac1d54c
  format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <password>4ac1d54c</password>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/password/edit?id=cc828c78c6fb9c16d31b7fc04dda963e&password=4ac1d54c&format=txt

Query parameters

      id = cc828c78c6fb9c16d31b7fc04dda963e
password = 4ac1d54c
  format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_password=4ac1d54c

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/password/edit?id=cc828c78c6fb9c16d31b7fc04dda963e&password=4ac1d54c&format=plain

Query parameters

      id = cc828c78c6fb9c16d31b7fc04dda963e
password = 4ac1d54c
  format = plain

Response

4ac1d54c
Required parameters
parameterdescriptionmax length
idIDID of the tracking link
passwordSTRINGpassword to use to protect the tracking link15
Return values
parameterdescription
passwordecho back of parameter password

/urls/password/info

access: [READ]

Get the password of a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/password/info?id=3eabddf5a31bef26e6702472f7c4f042

Query parameters

id = 3eabddf5a31bef26e6702472f7c4f042

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "password": "1d5a2203"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/password/info?id=3eabddf5a31bef26e6702472f7c4f042&format=xml

Query parameters

    id = 3eabddf5a31bef26e6702472f7c4f042
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <password>1d5a2203</password>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/password/info?id=3eabddf5a31bef26e6702472f7c4f042&format=txt

Query parameters

    id = 3eabddf5a31bef26e6702472f7c4f042
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_password=1d5a2203

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/password/info?id=3eabddf5a31bef26e6702472f7c4f042&format=plain

Query parameters

    id = 3eabddf5a31bef26e6702472f7c4f042
format = plain

Response

1d5a2203
Required parameters
parameterdescription
idIDID of the tracking link
Return values
parameterdescription
passwordpassword used to pretect the tracking link, empty otherwise

/urls/preview

/urls/preview/clone

access: [WRITE]

Clone the preview configuration from a tracking link to another.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/preview/clone?from_url_id=78987d9d875830238245efc48130edd3&to_url_id=f53a1fd0f38ecea49cc3268c7edeec95

Query parameters

from_url_id = 78987d9d875830238245efc48130edd3
  to_url_id = f53a1fd0f38ecea49cc3268c7edeec95

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "cloned": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/preview/clone?from_url_id=78987d9d875830238245efc48130edd3&to_url_id=f53a1fd0f38ecea49cc3268c7edeec95&format=xml

Query parameters

from_url_id = 78987d9d875830238245efc48130edd3
  to_url_id = f53a1fd0f38ecea49cc3268c7edeec95
     format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <cloned>1</cloned>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/preview/clone?from_url_id=78987d9d875830238245efc48130edd3&to_url_id=f53a1fd0f38ecea49cc3268c7edeec95&format=txt

Query parameters

from_url_id = 78987d9d875830238245efc48130edd3
  to_url_id = f53a1fd0f38ecea49cc3268c7edeec95
     format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_cloned=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/preview/clone?from_url_id=78987d9d875830238245efc48130edd3&to_url_id=f53a1fd0f38ecea49cc3268c7edeec95&format=plain

Query parameters

from_url_id = 78987d9d875830238245efc48130edd3
  to_url_id = f53a1fd0f38ecea49cc3268c7edeec95
     format = plain

Response

1
Required parameters
parameterdescription
from_url_idIDID of the tracking link you want to copy the preview configuration from
to_url_idIDID of the tracking link you want to copy the preview configuration to
Return values
parameterdescription
cloned1 on success, 0 otherwise

/urls/preview/delete

access: [WRITE]

Delete the preview option from a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/preview/delete?id=1e62cc481e3e309396fa1904d17b3894

Query parameters

id = 1e62cc481e3e309396fa1904d17b3894

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/preview/delete?id=1e62cc481e3e309396fa1904d17b3894&format=xml

Query parameters

    id = 1e62cc481e3e309396fa1904d17b3894
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/preview/delete?id=1e62cc481e3e309396fa1904d17b3894&format=txt

Query parameters

    id = 1e62cc481e3e309396fa1904d17b3894
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/preview/delete?id=1e62cc481e3e309396fa1904d17b3894&format=plain

Query parameters

    id = 1e62cc481e3e309396fa1904d17b3894
format = plain

Response

1
Required parameters
parameterdescription
idIDID of the tracking link from which to remove a preview configuration
Return values
parameterdescription
deleted1 on success, 0 otherwise

/urls/preview/edit

access: [WRITE]

Set a preview option for a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/preview/edit?id=2b38c0aabe569314b2e6c6a60e30eb7c&title=This+is+a+custom+title&description=This+is+a+custom+description&image=https%3A%2F%2Fpath.to%2Flink%2Fpreview%2Fimage.jpg

Query parameters

         id = 2b38c0aabe569314b2e6c6a60e30eb7c
      title = This is a custom title
description = This is a custom description
      image = https://path.to/link/preview/image.jpg

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "enabled": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/preview/edit?id=2b38c0aabe569314b2e6c6a60e30eb7c&title=This+is+a+custom+title&description=This+is+a+custom+description&image=https%3A%2F%2Fpath.to%2Flink%2Fpreview%2Fimage.jpg&format=xml

Query parameters

         id = 2b38c0aabe569314b2e6c6a60e30eb7c
      title = This is a custom title
description = This is a custom description
      image = https://path.to/link/preview/image.jpg
     format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <enabled>1</enabled>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/preview/edit?id=2b38c0aabe569314b2e6c6a60e30eb7c&title=This+is+a+custom+title&description=This+is+a+custom+description&image=https%3A%2F%2Fpath.to%2Flink%2Fpreview%2Fimage.jpg&format=txt

Query parameters

         id = 2b38c0aabe569314b2e6c6a60e30eb7c
      title = This is a custom title
description = This is a custom description
      image = https://path.to/link/preview/image.jpg
     format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_enabled=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/preview/edit?id=2b38c0aabe569314b2e6c6a60e30eb7c&title=This+is+a+custom+title&description=This+is+a+custom+description&image=https%3A%2F%2Fpath.to%2Flink%2Fpreview%2Fimage.jpg&format=plain

Query parameters

         id = 2b38c0aabe569314b2e6c6a60e30eb7c
      title = This is a custom title
description = This is a custom description
      image = https://path.to/link/preview/image.jpg
     format = plain

Response

1
Required parameters
parameterdescription
idIDID of the tracking link
Optional parameters
parameterdescriptionmax length
cdn_imageJSONJSON containing info on the CDN image to be used, if present it overrides the image parameter, see i1/cdns/list for details on this object
descriptionSTRINGOpen Graph description for the preview page2000
imageURLcomplete URL for the Open Graph image to be used, this URL must be in HTTPS to avoid securiy issues, alternatively you can pass a CDN image by using the cdn_image parameter4000
titleSTRINGOpen Graph title for the preview page2000
Return values
parameterdescription
enabled1 on success, 0 otherwise

/urls/preview/info

access: [READ]

Get link preview information for a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/preview/info?id=ad8b41b8bb462d9ffd0366aefc717671

Query parameters

id = ad8b41b8bb462d9ffd0366aefc717671

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "title": "This is a custom title",
    "description": "This is a custom description",
    "image": "https:\/\/path.to\/link\/preview\/image.jpg"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/preview/info?id=ad8b41b8bb462d9ffd0366aefc717671&format=xml

Query parameters

    id = ad8b41b8bb462d9ffd0366aefc717671
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <title>This is a custom title</title>  
    <description>This is a custom description</description>  
    <image>https://path.to/link/preview/image.jpg</image>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/preview/info?id=ad8b41b8bb462d9ffd0366aefc717671&format=txt

Query parameters

    id = ad8b41b8bb462d9ffd0366aefc717671
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_title=This is a custom title
result_description=This is a custom description
result_image=https://path.to/link/preview/image.jpg

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/preview/info?id=ad8b41b8bb462d9ffd0366aefc717671&format=plain

Query parameters

    id = ad8b41b8bb462d9ffd0366aefc717671
format = plain

Response

This is a custom title
This is a custom description
https://path.to/link/preview/image.jpg
Required parameters
parameterdescription
idIDID of the tracking link
Return values
parameterdescription
cdn_image[OPTIONAL] JSON containing info on the CDN image, see i1/urls/preview/edit for details
description[OPTIONAL] description to be shown in the link preview
image[OPTIONAL] image to be shown in the link preview
title[OPTIONAL] title to be shown in the link preview

/urls/preview/property

access: [READ]

Returns the list of available properties for the Preview option.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/preview/property

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "image": {
      "max_size": 512000,
      "max_width": 1200,
      "max_height": 630
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/preview/property?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <image>
      <max_size>512000</max_size>  
      <max_width>1200</max_width>  
      <max_height>630</max_height>  
    </image>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/preview/property?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_image_max_size=512000
result_image_max_width=1200
result_image_max_height=630

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/preview/property?format=plain

Query parameters

format = plain

Response

512000
1200
630
Return values
parameterdescription
imagelimits ( max_size in bytes, max_width in pixels, max_height in pixels) for the preview image

/urls/qrcodes

/urls/qrcodes/add

access: [WRITE]

Set a Qr code template for a short URL.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/qrcodes/add?id=cbeaf7916c57c4c2099c4359be7b3cbc&qrcode_id=158cc52c251ae8e0c784e95c0a6a28cc

Query parameters

       id = cbeaf7916c57c4c2099c4359be7b3cbc
qrcode_id = 158cc52c251ae8e0c784e95c0a6a28cc

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "added": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/qrcodes/add?id=cbeaf7916c57c4c2099c4359be7b3cbc&qrcode_id=158cc52c251ae8e0c784e95c0a6a28cc&format=xml

Query parameters

       id = cbeaf7916c57c4c2099c4359be7b3cbc
qrcode_id = 158cc52c251ae8e0c784e95c0a6a28cc
   format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <added>1</added>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/qrcodes/add?id=cbeaf7916c57c4c2099c4359be7b3cbc&qrcode_id=158cc52c251ae8e0c784e95c0a6a28cc&format=txt

Query parameters

       id = cbeaf7916c57c4c2099c4359be7b3cbc
qrcode_id = 158cc52c251ae8e0c784e95c0a6a28cc
   format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_added=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/qrcodes/add?id=cbeaf7916c57c4c2099c4359be7b3cbc&qrcode_id=158cc52c251ae8e0c784e95c0a6a28cc&format=plain

Query parameters

       id = cbeaf7916c57c4c2099c4359be7b3cbc
qrcode_id = 158cc52c251ae8e0c784e95c0a6a28cc
   format = plain

Response

1
Required parameters
parameterdescription
idIDID of the tracking link
qrcode_idIDID of the QR code template to associate to the tracking link
Return values
parameterdescription
added1 on success, 0 otherwise

/urls/qrcodes/clone

access: [WRITE]

Clone the qrcodes configuration from a tracking link to another.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/qrcodes/clone?from_url_id=59e52ef9b1f9e865e97df0ab1a14919c&to_url_id=65e6897e849ffc472630fababa39d077

Query parameters

from_url_id = 59e52ef9b1f9e865e97df0ab1a14919c
  to_url_id = 65e6897e849ffc472630fababa39d077

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "cloned": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/qrcodes/clone?from_url_id=59e52ef9b1f9e865e97df0ab1a14919c&to_url_id=65e6897e849ffc472630fababa39d077&format=xml

Query parameters

from_url_id = 59e52ef9b1f9e865e97df0ab1a14919c
  to_url_id = 65e6897e849ffc472630fababa39d077
     format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <cloned>1</cloned>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/qrcodes/clone?from_url_id=59e52ef9b1f9e865e97df0ab1a14919c&to_url_id=65e6897e849ffc472630fababa39d077&format=txt

Query parameters

from_url_id = 59e52ef9b1f9e865e97df0ab1a14919c
  to_url_id = 65e6897e849ffc472630fababa39d077
     format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_cloned=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/qrcodes/clone?from_url_id=59e52ef9b1f9e865e97df0ab1a14919c&to_url_id=65e6897e849ffc472630fababa39d077&format=plain

Query parameters

from_url_id = 59e52ef9b1f9e865e97df0ab1a14919c
  to_url_id = 65e6897e849ffc472630fababa39d077
     format = plain

Response

1
Required parameters
parameterdescription
from_url_idIDID of the tracking link you want to copy qrcode configuration from
to_url_idIDID of the tracking link you want to copy qrcode configuration to
Return values
parameterdescription
cloned1 on success, 0 otherwise

/urls/qrcodes/delete

access: [WRITE]

Unset a Qr code template for a short URL.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/qrcodes/delete?id=15fdfdcacaa4b614c60eb1376e3e3c2f&qrcode_id=9a4641d1cfd72c87ad896540989a22ff

Query parameters

       id = 15fdfdcacaa4b614c60eb1376e3e3c2f
qrcode_id = 9a4641d1cfd72c87ad896540989a22ff

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/qrcodes/delete?id=15fdfdcacaa4b614c60eb1376e3e3c2f&qrcode_id=9a4641d1cfd72c87ad896540989a22ff&format=xml

Query parameters

       id = 15fdfdcacaa4b614c60eb1376e3e3c2f
qrcode_id = 9a4641d1cfd72c87ad896540989a22ff
   format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/qrcodes/delete?id=15fdfdcacaa4b614c60eb1376e3e3c2f&qrcode_id=9a4641d1cfd72c87ad896540989a22ff&format=txt

Query parameters

       id = 15fdfdcacaa4b614c60eb1376e3e3c2f
qrcode_id = 9a4641d1cfd72c87ad896540989a22ff
   format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/qrcodes/delete?id=15fdfdcacaa4b614c60eb1376e3e3c2f&qrcode_id=9a4641d1cfd72c87ad896540989a22ff&format=plain

Query parameters

       id = 15fdfdcacaa4b614c60eb1376e3e3c2f
qrcode_id = 9a4641d1cfd72c87ad896540989a22ff
   format = plain

Response

1
Required parameters
parameterdescription
idIDID of the tracking link from which to remove the QR code configuration
Optional parameters
parameterdescription
qrcode_idIDID of the QR code configuration
Return values
parameterdescription
deleted1 on success, 0 otherwise

/urls/qrcodes/info

access: [READ]

Returns information on QR code customization, if present.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/qrcodes/info?id=e5625f76fd1482808cc3a7e68a5a571c&fields=id,name,shape

Query parameters

    id = e5625f76fd1482808cc3a7e68a5a571c
fields = id,name,shape

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "d1fc6cb78e77af23b9b296b4fece970e",
    "name": "QR code template name",
    "shape": "rhombus"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/qrcodes/info?id=e5625f76fd1482808cc3a7e68a5a571c&fields=id,name,shape&format=xml

Query parameters

    id = e5625f76fd1482808cc3a7e68a5a571c
fields = id,name,shape
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>d1fc6cb78e77af23b9b296b4fece970e</id>  
    <name>QR code template name</name>  
    <shape>rhombus</shape>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/qrcodes/info?id=e5625f76fd1482808cc3a7e68a5a571c&fields=id,name,shape&format=txt

Query parameters

    id = e5625f76fd1482808cc3a7e68a5a571c
fields = id,name,shape
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=d1fc6cb78e77af23b9b296b4fece970e
result_name=QR code template name
result_shape=rhombus

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/qrcodes/info?id=e5625f76fd1482808cc3a7e68a5a571c&fields=id,name,shape&format=plain

Query parameters

    id = e5625f76fd1482808cc3a7e68a5a571c
fields = id,name,shape
format = plain

Response

d1fc6cb78e77af23b9b296b4fece970e
QR code template name
rhombus
Required parameters
parameterdescription
fieldsARRAYcomma-separated list of fields to return, see i1/qrcodes/info for details
idIDID of the tracking link
Return values
parameterdescription
datasee i1/qrcodes/info for details

/urls/qrcodes/preview

access: [READ]

This method returns a preview of the QR code associated to the tracking link (if any).

Example 1 (json)

Request

https://joturl.com/a/i1/urls/qrcodes/preview?size=big&id=a74436ecddbe222522c896fbc3de9445

Query parameters

size = big
  id = a74436ecddbe222522c896fbc3de9445

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "img": "data:image\/png;base64,NmRmY2UwMzdhYjU5MTkzNDg3ZjRlNzM3OTk3OGVmZGI="
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/qrcodes/preview?size=big&id=a74436ecddbe222522c896fbc3de9445&format=xml

Query parameters

  size = big
    id = a74436ecddbe222522c896fbc3de9445
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <img>data:image/png;base64,NmRmY2UwMzdhYjU5MTkzNDg3ZjRlNzM3OTk3OGVmZGI=</img>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/qrcodes/preview?size=big&id=a74436ecddbe222522c896fbc3de9445&format=txt

Query parameters

  size = big
    id = a74436ecddbe222522c896fbc3de9445
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_img=data:image/png;base64,NmRmY2UwMzdhYjU5MTkzNDg3ZjRlNzM3OTk3OGVmZGI=

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/qrcodes/preview?size=big&id=a74436ecddbe222522c896fbc3de9445&format=plain

Query parameters

  size = big
    id = a74436ecddbe222522c896fbc3de9445
format = plain

Response

data:image/png;base64,NmRmY2UwMzdhYjU5MTkzNDg3ZjRlNzM3OTk3OGVmZGI=
Required parameters
parameterdescription
idIDID of the tracking link
Optional parameters
parameterdescription
downloadBOOLEANsee i1/qrcodes/preview for details
return_imageBOOLEANsee i1/qrcodes/preview for details
sizeSTRINGsee i1/qrcodes/preview for details
typeSTRINGsee i1/qrcodes/preview for details
Return values
parameterdescription
[BINARY DATA]see i1/qrcodes/preview for details
imgsee i1/qrcodes/preview for details

/urls/remarketings

/urls/remarketings/add

access: [WRITE]

Add remarketing pixels to a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/remarketings/add?url_id=08f6334462bd733338593b08df6a18d3&ids=06e6e952a6a892629776ff84d996a844,002a0cf1cf392c23e70b254f83cc6887

Query parameters

url_id = 08f6334462bd733338593b08df6a18d3
   ids = 06e6e952a6a892629776ff84d996a844,002a0cf1cf392c23e70b254f83cc6887

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "added": 2
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/remarketings/add?url_id=08f6334462bd733338593b08df6a18d3&ids=06e6e952a6a892629776ff84d996a844,002a0cf1cf392c23e70b254f83cc6887&format=xml

Query parameters

url_id = 08f6334462bd733338593b08df6a18d3
   ids = 06e6e952a6a892629776ff84d996a844,002a0cf1cf392c23e70b254f83cc6887
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <added>2</added>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/remarketings/add?url_id=08f6334462bd733338593b08df6a18d3&ids=06e6e952a6a892629776ff84d996a844,002a0cf1cf392c23e70b254f83cc6887&format=txt

Query parameters

url_id = 08f6334462bd733338593b08df6a18d3
   ids = 06e6e952a6a892629776ff84d996a844,002a0cf1cf392c23e70b254f83cc6887
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_added=2

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/remarketings/add?url_id=08f6334462bd733338593b08df6a18d3&ids=06e6e952a6a892629776ff84d996a844,002a0cf1cf392c23e70b254f83cc6887&format=plain

Query parameters

url_id = 08f6334462bd733338593b08df6a18d3
   ids = 06e6e952a6a892629776ff84d996a844,002a0cf1cf392c23e70b254f83cc6887
format = plain

Response

2
Required parameters
parameterdescription
idsARRAY_OF_IDScomma-separated list of remarketing pixels to add (maxmimum number of remarketing pixels: 5)
url_idIDID of the tracking link to which to add one or more remarketing pixels
Return values
parameterdescription
added0 on error, the number of added remarketing pixels otherwise

/urls/remarketings/clone

access: [WRITE]

Clone the remarketings configuration from a tracking link to another.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/remarketings/clone?from_url_id=8536717721649e27836d48d637f0dcc2&to_url_id=3e36eb76d7931e2020a4d65f6fef721c

Query parameters

from_url_id = 8536717721649e27836d48d637f0dcc2
  to_url_id = 3e36eb76d7931e2020a4d65f6fef721c

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "cloned": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/remarketings/clone?from_url_id=8536717721649e27836d48d637f0dcc2&to_url_id=3e36eb76d7931e2020a4d65f6fef721c&format=xml

Query parameters

from_url_id = 8536717721649e27836d48d637f0dcc2
  to_url_id = 3e36eb76d7931e2020a4d65f6fef721c
     format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <cloned>1</cloned>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/remarketings/clone?from_url_id=8536717721649e27836d48d637f0dcc2&to_url_id=3e36eb76d7931e2020a4d65f6fef721c&format=txt

Query parameters

from_url_id = 8536717721649e27836d48d637f0dcc2
  to_url_id = 3e36eb76d7931e2020a4d65f6fef721c
     format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_cloned=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/remarketings/clone?from_url_id=8536717721649e27836d48d637f0dcc2&to_url_id=3e36eb76d7931e2020a4d65f6fef721c&format=plain

Query parameters

from_url_id = 8536717721649e27836d48d637f0dcc2
  to_url_id = 3e36eb76d7931e2020a4d65f6fef721c
     format = plain

Response

1
Required parameters
parameterdescription
from_url_idIDID of the tracking link you want to copy the remarketings configuration from
to_url_idIDID of the tracking link you want to copy the remarketings configuration to
Return values
parameterdescription
cloned1 on success, 0 otherwise

/urls/remarketings/count

access: [READ]

This method returns the number of remarketing pixels linked to a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/remarketings/count?url_id=6fc5a55c16dd1ab97d6324f700ead069

Query parameters

url_id = 6fc5a55c16dd1ab97d6324f700ead069

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/remarketings/count?url_id=6fc5a55c16dd1ab97d6324f700ead069&format=xml

Query parameters

url_id = 6fc5a55c16dd1ab97d6324f700ead069
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>1</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/remarketings/count?url_id=6fc5a55c16dd1ab97d6324f700ead069&format=txt

Query parameters

url_id = 6fc5a55c16dd1ab97d6324f700ead069
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/remarketings/count?url_id=6fc5a55c16dd1ab97d6324f700ead069&format=plain

Query parameters

url_id = 6fc5a55c16dd1ab97d6324f700ead069
format = plain

Response

1
Required parameters
parameterdescription
url_idIDID of the tracking link to check
Return values
parameterdescription
countthe number of linked remakerting pixels

/urls/remarketings/delete

access: [WRITE]

Delete one or more remarketing pixels linked to a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/remarketings/delete?url_id=d025abb7ec8901a33bb00882ec2acf9c

Query parameters

url_id = d025abb7ec8901a33bb00882ec2acf9c

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/remarketings/delete?url_id=d025abb7ec8901a33bb00882ec2acf9c&format=xml

Query parameters

url_id = d025abb7ec8901a33bb00882ec2acf9c
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/remarketings/delete?url_id=d025abb7ec8901a33bb00882ec2acf9c&format=txt

Query parameters

url_id = d025abb7ec8901a33bb00882ec2acf9c
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/remarketings/delete?url_id=d025abb7ec8901a33bb00882ec2acf9c&format=plain

Query parameters

url_id = d025abb7ec8901a33bb00882ec2acf9c
format = plain

Response

1
Required parameters
parameterdescription
url_idIDID of the tracking link from which to remove one or more remarketing pixels
Optional parameters
parameterdescription
idsARRAY_OF_IDScomma-separated list of remarketing pixels to remove, if empty all remarketing pixels will be removed
Return values
parameterdescription
deleted1 on success, 0 otherwise

/urls/remarketings/edit

access: [WRITE]

Edit the list of tracking pixels linked to a tracking link (all previous tracking pixels are removed).

Example 1 (json)

Request

https://joturl.com/a/i1/urls/remarketings/edit?url_id=3da009625db142cc20aea15902414f77&ids=619ab23d8f7c4c078225909d2c28b8e0,4cfefdfd950c830404209e24768a3921,18aebe5af181ec1b924ebb2f85496171

Query parameters

url_id = 3da009625db142cc20aea15902414f77
   ids = 619ab23d8f7c4c078225909d2c28b8e0,4cfefdfd950c830404209e24768a3921,18aebe5af181ec1b924ebb2f85496171

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "ids": "619ab23d8f7c4c078225909d2c28b8e0,4cfefdfd950c830404209e24768a3921,18aebe5af181ec1b924ebb2f85496171"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/remarketings/edit?url_id=3da009625db142cc20aea15902414f77&ids=619ab23d8f7c4c078225909d2c28b8e0,4cfefdfd950c830404209e24768a3921,18aebe5af181ec1b924ebb2f85496171&format=xml

Query parameters

url_id = 3da009625db142cc20aea15902414f77
   ids = 619ab23d8f7c4c078225909d2c28b8e0,4cfefdfd950c830404209e24768a3921,18aebe5af181ec1b924ebb2f85496171
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <ids>619ab23d8f7c4c078225909d2c28b8e0,4cfefdfd950c830404209e24768a3921,18aebe5af181ec1b924ebb2f85496171</ids>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/remarketings/edit?url_id=3da009625db142cc20aea15902414f77&ids=619ab23d8f7c4c078225909d2c28b8e0,4cfefdfd950c830404209e24768a3921,18aebe5af181ec1b924ebb2f85496171&format=txt

Query parameters

url_id = 3da009625db142cc20aea15902414f77
   ids = 619ab23d8f7c4c078225909d2c28b8e0,4cfefdfd950c830404209e24768a3921,18aebe5af181ec1b924ebb2f85496171
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_ids=619ab23d8f7c4c078225909d2c28b8e0,4cfefdfd950c830404209e24768a3921,18aebe5af181ec1b924ebb2f85496171

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/remarketings/edit?url_id=3da009625db142cc20aea15902414f77&ids=619ab23d8f7c4c078225909d2c28b8e0,4cfefdfd950c830404209e24768a3921,18aebe5af181ec1b924ebb2f85496171&format=plain

Query parameters

url_id = 3da009625db142cc20aea15902414f77
   ids = 619ab23d8f7c4c078225909d2c28b8e0,4cfefdfd950c830404209e24768a3921,18aebe5af181ec1b924ebb2f85496171
format = plain

Response

619ab23d8f7c4c078225909d2c28b8e0,4cfefdfd950c830404209e24768a3921,18aebe5af181ec1b924ebb2f85496171
Required parameters
parameterdescription
idsARRAY_OF_IDScomma-separated list of remarketing pixels to add (maxmimum number of remarketing pixels: 5)
url_idIDID of the tracking link to which to add one or more remarketing pixels
Return values
parameterdescription
idscomma-separated list of added remarketing pixels

/urls/remarketings/list

access: [READ]

This method returns a list of remarketing pixels linked to a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/remarketings/list?fields=count,id,name,notes,code_type,code_id&url_id=dd3d5113ad408412c414af0e4feb886f

Query parameters

fields = count,id,name,notes,code_type,code_id
url_id = dd3d5113ad408412c414af0e4feb886f

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 2,
    "data": [
      {
        "id": "c7265dcf9f8d3d3bfbb052cb7e28953d",
        "name": "remarketing pixel (bing)",
        "notes": "",
        "code_type": "bing",
        "code_id": "1234567890A"
      },
      {
        "id": "4679f000f19cc02850eebe473353f419",
        "name": "remarketing pixel (facebook)",
        "notes": "remarketing pixel for FB",
        "code_type": "facebook",
        "code_id": "A0987654321"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/remarketings/list?fields=count,id,name,notes,code_type,code_id&url_id=dd3d5113ad408412c414af0e4feb886f&format=xml

Query parameters

fields = count,id,name,notes,code_type,code_id
url_id = dd3d5113ad408412c414af0e4feb886f
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>2</count>  
    <data>
      <i0>
        <id>c7265dcf9f8d3d3bfbb052cb7e28953d</id>  
        <name>remarketing pixel (bing)</name>  
        <notes></notes>  
        <code_type>bing</code_type>  
        <code_id>1234567890A</code_id>  
      </i0>  
      <i1>
        <id>4679f000f19cc02850eebe473353f419</id>  
        <name>remarketing pixel (facebook)</name>  
        <notes>remarketing pixel for FB</notes>  
        <code_type>facebook</code_type>  
        <code_id>A0987654321</code_id>  
      </i1>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/remarketings/list?fields=count,id,name,notes,code_type,code_id&url_id=dd3d5113ad408412c414af0e4feb886f&format=txt

Query parameters

fields = count,id,name,notes,code_type,code_id
url_id = dd3d5113ad408412c414af0e4feb886f
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=2
result_data_0_id=c7265dcf9f8d3d3bfbb052cb7e28953d
result_data_0_name=remarketing pixel (bing)
result_data_0_notes=
result_data_0_code_type=bing
result_data_0_code_id=1234567890A
result_data_1_id=4679f000f19cc02850eebe473353f419
result_data_1_name=remarketing pixel (facebook)
result_data_1_notes=remarketing pixel for FB
result_data_1_code_type=facebook
result_data_1_code_id=A0987654321

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/remarketings/list?fields=count,id,name,notes,code_type,code_id&url_id=dd3d5113ad408412c414af0e4feb886f&format=plain

Query parameters

fields = count,id,name,notes,code_type,code_id
url_id = dd3d5113ad408412c414af0e4feb886f
format = plain

Response

2
c7265dcf9f8d3d3bfbb052cb7e28953d
remarketing pixel (bing)

bing
1234567890A
4679f000f19cc02850eebe473353f419
remarketing pixel (facebook)
remarketing pixel for FB
facebook
A0987654321
Required parameters
parameterdescription
fieldsARRAYcomma-separated list of fields to return, available fields: count, id, name, notes, code_type, code_id
url_idIDID of the liked tracking link
Optional parameters
parameterdescription
lengthINTEGERextracts this number of remarketing pixels (maxmimum allowed: 100)
orderbyARRAYorders remarketing pixels by field, available fields: id, name, notes, code_type, code_id
searchSTRINGfilters remarketing pixels to be extracted by searching them
sortSTRINGsorts remarketing pixels in ascending (ASC) or descending (DESC) order
startINTEGERstarts to extract remarketing pixels from this position
Return values
parameterdescription
dataarray containing information on the remarketing pixels, returned information depends on the fields parameter.

/urls/selfdestruction

/urls/selfdestruction/clone

access: [WRITE]

Clone a self destruction configuration from a tracking link to another.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/selfdestruction/clone?from_url_id=7667dd466f47da0d181e84bcc019d7fb&to_url_id=a6558ed1b825f19bf6b51092c0c43b77

Query parameters

from_url_id = 7667dd466f47da0d181e84bcc019d7fb
  to_url_id = a6558ed1b825f19bf6b51092c0c43b77

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "cloned": 0
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/selfdestruction/clone?from_url_id=7667dd466f47da0d181e84bcc019d7fb&to_url_id=a6558ed1b825f19bf6b51092c0c43b77&format=xml

Query parameters

from_url_id = 7667dd466f47da0d181e84bcc019d7fb
  to_url_id = a6558ed1b825f19bf6b51092c0c43b77
     format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <cloned>0</cloned>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/selfdestruction/clone?from_url_id=7667dd466f47da0d181e84bcc019d7fb&to_url_id=a6558ed1b825f19bf6b51092c0c43b77&format=txt

Query parameters

from_url_id = 7667dd466f47da0d181e84bcc019d7fb
  to_url_id = a6558ed1b825f19bf6b51092c0c43b77
     format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_cloned=0

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/selfdestruction/clone?from_url_id=7667dd466f47da0d181e84bcc019d7fb&to_url_id=a6558ed1b825f19bf6b51092c0c43b77&format=plain

Query parameters

from_url_id = 7667dd466f47da0d181e84bcc019d7fb
  to_url_id = a6558ed1b825f19bf6b51092c0c43b77
     format = plain

Response

0
Required parameters
parameterdescription
from_url_idIDID of the tracking link you want to copy self destruction configuration from
to_url_idIDID of the tracking link you want to copy self destruction configuration to
Return values
parameterdescription
cloned1 on success, 0 otherwise

/urls/selfdestruction/delete

access: [WRITE]

Delete the self destruction configuration of a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/selfdestruction/delete?id=c3902ea617430c181768bb5059555211

Query parameters

id = c3902ea617430c181768bb5059555211

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/selfdestruction/delete?id=c3902ea617430c181768bb5059555211&format=xml

Query parameters

    id = c3902ea617430c181768bb5059555211
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/selfdestruction/delete?id=c3902ea617430c181768bb5059555211&format=txt

Query parameters

    id = c3902ea617430c181768bb5059555211
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/selfdestruction/delete?id=c3902ea617430c181768bb5059555211&format=plain

Query parameters

    id = c3902ea617430c181768bb5059555211
format = plain

Response

1
Required parameters
parameterdescription
idIDID of the tracking link from which to remove a self destruction configuration
Return values
parameterdescription
deleted1 on success, 0 otherwise

/urls/selfdestruction/edit

access: [WRITE]

Given the ID of a tracking link, sets a self destruction configuration.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/selfdestruction/edit?id=0c7b42d352d9164da4ab4be670b9cf4d&time_offset=1&time_base=years&from_what=creation&condition_var=visits&condition_operand=%3C%3D&condition_value=100

Query parameters

               id = 0c7b42d352d9164da4ab4be670b9cf4d
      time_offset = 1
        time_base = years
        from_what = creation
    condition_var = visits
condition_operand = <=
  condition_value = 100

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "time_offset": "1",
    "time_base": "years",
    "from_what": "creation",
    "condition_var": "visits",
    "condition_operand": "<=",
    "condition_value": "100"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/selfdestruction/edit?id=0c7b42d352d9164da4ab4be670b9cf4d&time_offset=1&time_base=years&from_what=creation&condition_var=visits&condition_operand=%3C%3D&condition_value=100&format=xml

Query parameters

               id = 0c7b42d352d9164da4ab4be670b9cf4d
      time_offset = 1
        time_base = years
        from_what = creation
    condition_var = visits
condition_operand = <=
  condition_value = 100
           format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <time_offset>1</time_offset>  
    <time_base>years</time_base>  
    <from_what>creation</from_what>  
    <condition_var>visits</condition_var>  
    <condition_operand><[CDATA[&lt;=]]></condition_operand>  
    <condition_value>100</condition_value>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/selfdestruction/edit?id=0c7b42d352d9164da4ab4be670b9cf4d&time_offset=1&time_base=years&from_what=creation&condition_var=visits&condition_operand=%3C%3D&condition_value=100&format=txt

Query parameters

               id = 0c7b42d352d9164da4ab4be670b9cf4d
      time_offset = 1
        time_base = years
        from_what = creation
    condition_var = visits
condition_operand = <=
  condition_value = 100
           format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_time_offset=1
result_time_base=years
result_from_what=creation
result_condition_var=visits
result_condition_operand=&lt;=
result_condition_value=100

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/selfdestruction/edit?id=0c7b42d352d9164da4ab4be670b9cf4d&time_offset=1&time_base=years&from_what=creation&condition_var=visits&condition_operand=%3C%3D&condition_value=100&format=plain

Query parameters

               id = 0c7b42d352d9164da4ab4be670b9cf4d
      time_offset = 1
        time_base = years
        from_what = creation
    condition_var = visits
condition_operand = <=
  condition_value = 100
           format = plain

Response

1
years
creation
visits
&lt;=
100
Required parameters
parameterdescription
condition_varENUMthe condition to be met in order to delete the tracking link, see notes for a list of available variables
from_whatENUMtime reference, the event from which the time_offset is evaluated, see notes for a list of available time references
idIDID of the tracking link
time_baseENUMtime base, see notes for a list of available time bases
time_offsetINTEGERtime offset (integer greater than 0)
Optional parameters
parameterdescription
condition_operandENUMthe operand for the condition_var, see notes for a list of available operands; mandatory if condition_var is different from inanycase
condition_valueINTEGERthe value to be used with condition_var (integer greater than or equal to 0), mandatory if condition_var is different from inanycase
from_dtDATETIME/EMPTYcustom date/time, it cannot be in the past, mandatory when from_what = datetime, otherwise it is ignored
Return values
parameterdescription
condition_operandecho back of the input parameter condition_operand
condition_valueecho back of the input parameter condition_value
condition_varecho back of the input parameter condition_var
from_dtecho back of the input parameter from_dt
from_whatecho back of the input parameter from_what
idecho back of the input parameter id
time_baseecho back of the input parameter time_base
time_offsetecho back of the input parameter time_offset

/urls/selfdestruction/info

access: [READ]

Returns information on the self destruction configuration.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/selfdestruction/info?id=36c8d8fdd7f223bd933b2d675341ebe3

Query parameters

id = 36c8d8fdd7f223bd933b2d675341ebe3

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "36c8d8fdd7f223bd933b2d675341ebe3",
    "time_offset": "1",
    "time_base": "years",
    "from_what": "creation",
    "condition_var": "visits",
    "condition_operand": "<=",
    "condition_value": "100"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/selfdestruction/info?id=36c8d8fdd7f223bd933b2d675341ebe3&format=xml

Query parameters

    id = 36c8d8fdd7f223bd933b2d675341ebe3
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>36c8d8fdd7f223bd933b2d675341ebe3</id>  
    <time_offset>1</time_offset>  
    <time_base>years</time_base>  
    <from_what>creation</from_what>  
    <condition_var>visits</condition_var>  
    <condition_operand><[CDATA[&lt;=]]></condition_operand>  
    <condition_value>100</condition_value>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/selfdestruction/info?id=36c8d8fdd7f223bd933b2d675341ebe3&format=txt

Query parameters

    id = 36c8d8fdd7f223bd933b2d675341ebe3
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=36c8d8fdd7f223bd933b2d675341ebe3
result_time_offset=1
result_time_base=years
result_from_what=creation
result_condition_var=visits
result_condition_operand=&lt;=
result_condition_value=100

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/selfdestruction/info?id=36c8d8fdd7f223bd933b2d675341ebe3&format=plain

Query parameters

    id = 36c8d8fdd7f223bd933b2d675341ebe3
format = plain

Response

36c8d8fdd7f223bd933b2d675341ebe3
1
years
creation
visits
&lt;=
100
Required parameters
parameterdescription
idIDID of the tracking link
Return values
parameterdescription
condition_operandsee i1/urls/selfdestruction/edit for details
condition_valuesee i1/urls/selfdestruction/edit for details
condition_varsee i1/urls/selfdestruction/edit for details
from_dtsee i1/urls/selfdestruction/edit for details
from_whatsee i1/urls/selfdestruction/edit for details
idsee i1/urls/selfdestruction/edit for details
time_basesee i1/urls/selfdestruction/edit for details
time_offsetsee i1/urls/selfdestruction/edit for details

/urls/shorten

access: [WRITE]

Creates a shorten tracking link for a given destination URL.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/shorten?alias=jot&domain_id=cdb6a09a976ab1b88426372476b23df9&project_id=57bf20fa817e8dff9343429da0b56150&long_url=https%3A%2F%2Fwww.joturl.com%2F

Query parameters

     alias = jot
 domain_id = cdb6a09a976ab1b88426372476b23df9
project_id = 57bf20fa817e8dff9343429da0b56150
  long_url = https://www.joturl.com/

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "d213d0f3e93639c5537c7a0190c3aa7c",
    "alias": "jot",
    "domain_id": "cdb6a09a976ab1b88426372476b23df9",
    "domain_host": "jo.my",
    "domain_nickname": "",
    "project_id": "57bf20fa817e8dff9343429da0b56150",
    "project_name": "project name",
    "short_url": "\/\/jo.my\/jot",
    "long_url": "https:\/\/www.joturl.com\/",
    "template_type": 1,
    "notes": ""
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/shorten?alias=jot&domain_id=cdb6a09a976ab1b88426372476b23df9&project_id=57bf20fa817e8dff9343429da0b56150&long_url=https%3A%2F%2Fwww.joturl.com%2F&format=xml

Query parameters

     alias = jot
 domain_id = cdb6a09a976ab1b88426372476b23df9
project_id = 57bf20fa817e8dff9343429da0b56150
  long_url = https://www.joturl.com/
    format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>d213d0f3e93639c5537c7a0190c3aa7c</id>  
    <alias>jot</alias>  
    <domain_id>cdb6a09a976ab1b88426372476b23df9</domain_id>  
    <domain_host>jo.my</domain_host>  
    <domain_nickname></domain_nickname>  
    <project_id>57bf20fa817e8dff9343429da0b56150</project_id>  
    <project_name>project name</project_name>  
    <short_url>//jo.my/jot</short_url>  
    <long_url>https://www.joturl.com/</long_url>  
    <template_type>1</template_type>  
    <notes></notes>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/shorten?alias=jot&domain_id=cdb6a09a976ab1b88426372476b23df9&project_id=57bf20fa817e8dff9343429da0b56150&long_url=https%3A%2F%2Fwww.joturl.com%2F&format=txt

Query parameters

     alias = jot
 domain_id = cdb6a09a976ab1b88426372476b23df9
project_id = 57bf20fa817e8dff9343429da0b56150
  long_url = https://www.joturl.com/
    format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=d213d0f3e93639c5537c7a0190c3aa7c
result_alias=jot
result_domain_id=cdb6a09a976ab1b88426372476b23df9
result_domain_host=jo.my
result_domain_nickname=
result_project_id=57bf20fa817e8dff9343429da0b56150
result_project_name=project name
result_short_url=//jo.my/jot
result_long_url=https://www.joturl.com/
result_template_type=1
result_notes=

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/shorten?alias=jot&domain_id=cdb6a09a976ab1b88426372476b23df9&project_id=57bf20fa817e8dff9343429da0b56150&long_url=https%3A%2F%2Fwww.joturl.com%2F&format=plain

Query parameters

     alias = jot
 domain_id = cdb6a09a976ab1b88426372476b23df9
project_id = 57bf20fa817e8dff9343429da0b56150
  long_url = https://www.joturl.com/
    format = plain

Response

//jo.my/jot

Example 5 (json)

Request

https://joturl.com/a/i1/urls/shorten?alias=jot&domain_id=98d06314867d8200d5182542294384a0&project_id=2229ca05e1222dd2cdb6c8f6a276db4f&long_url=https%3A%2F%2Fwww.joturl.com%2F¬es=trying+to+shorten+a+URL+whose+alias+was+already+used

Query parameters

     alias = jot
 domain_id = 98d06314867d8200d5182542294384a0
project_id = 2229ca05e1222dd2cdb6c8f6a276db4f
  long_url = https://www.joturl.com/
     notes = trying to shorten a URL whose alias was already used

Response

{
  "status": {
    "code": 503,
    "text": "GENERIC ERROR",
    "error": "The chosen alias is not available.",
    "rate": 3
  },
  "result": []
}

Example 6 (xml)

Request

https://joturl.com/a/i1/urls/shorten?alias=jot&domain_id=98d06314867d8200d5182542294384a0&project_id=2229ca05e1222dd2cdb6c8f6a276db4f&long_url=https%3A%2F%2Fwww.joturl.com%2F¬es=trying+to+shorten+a+URL+whose+alias+was+already+used&format=xml

Query parameters

     alias = jot
 domain_id = 98d06314867d8200d5182542294384a0
project_id = 2229ca05e1222dd2cdb6c8f6a276db4f
  long_url = https://www.joturl.com/
     notes = trying to shorten a URL whose alias was already used
    format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>503</code>  
    <text>GENERIC ERROR</text>  
    <error>The chosen alias is not available.</error>  
    <rate>3</rate>  
  </status>  
  <result>

  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/urls/shorten?alias=jot&domain_id=98d06314867d8200d5182542294384a0&project_id=2229ca05e1222dd2cdb6c8f6a276db4f&long_url=https%3A%2F%2Fwww.joturl.com%2F¬es=trying+to+shorten+a+URL+whose+alias+was+already+used&format=txt

Query parameters

     alias = jot
 domain_id = 98d06314867d8200d5182542294384a0
project_id = 2229ca05e1222dd2cdb6c8f6a276db4f
  long_url = https://www.joturl.com/
     notes = trying to shorten a URL whose alias was already used
    format = txt

Response

status_code=503
status_text=GENERIC ERROR
status_error=The chosen alias is not available.
status_rate=3
result=

Example 8 (plain)

Request

https://joturl.com/a/i1/urls/shorten?alias=jot&domain_id=98d06314867d8200d5182542294384a0&project_id=2229ca05e1222dd2cdb6c8f6a276db4f&long_url=https%3A%2F%2Fwww.joturl.com%2F¬es=trying+to+shorten+a+URL+whose+alias+was+already+used&format=plain

Query parameters

     alias = jot
 domain_id = 98d06314867d8200d5182542294384a0
project_id = 2229ca05e1222dd2cdb6c8f6a276db4f
  long_url = https://www.joturl.com/
     notes = trying to shorten a URL whose alias was already used
    format = plain

Response

Example 9 (json)

Request

https://joturl.com/a/i1/urls/shorten?domain_id=06c497bebccc9536b5f55b13732e827d&project_id=6d97731a4989fb6235e967c9a518cd93&bulk=1&info=%5B%7B%22url%22%3A%22https%3A%5C%2F%5C%2Fwww.joturl.com%5C%2F%3Fp%3D0%22,%22alias%22%3A%22alias0%22%7D,%7B%22url%22%3A%22https%3A%5C%2F%5C%2Fwww.joturl.com%5C%2F%3Fp%3D1%22,%22alias%22%3A%22alias1%22%7D,%7B%22url%22%3A%22https%3A%5C%2F%5C%2Fwww.joturl.com%5C%2F%3Fp%3D2%22,%22alias%22%3A%22alias1%22%7D%5D

Query parameters

 domain_id = 06c497bebccc9536b5f55b13732e827d
project_id = 6d97731a4989fb6235e967c9a518cd93
      bulk = 1
      info = [{"url":"https:\/\/www.joturl.com\/?p=0","alias":"alias0"},{"url":"https:\/\/www.joturl.com\/?p=1","alias":"alias1"},{"url":"https:\/\/www.joturl.com\/?p=2","alias":"alias1"}]

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": [
    {
      "id": "6721cd606ae63e327e58704d3ea68ba5",
      "alias": "alias0",
      "domain_id": "e4f5789ae959f47960e9085fe383f8a6",
      "domain_host": "my.custom.domain",
      "domain_nickname": "",
      "project_id": "c938d97fb333d4b1fbf906b760afa29b",
      "project_name": "project name",
      "short_url": "\/\/my.custom.domain\/alias0",
      "long_url": "https:\/\/www.joturl.com\/?p=0",
      "template_type": 1
    },
    {
      "id": "df37738f53598586292942fa4ab5c2d5",
      "alias": "alias1",
      "domain_id": "c162847cfbcbc6ebb9db08f43272b34a",
      "domain_host": "my.custom.domain",
      "domain_nickname": "",
      "project_id": "f2971419c7a5e2d5bed201d7483a0c35",
      "project_name": "project name",
      "short_url": "\/\/my.custom.domain\/alias1",
      "long_url": "https:\/\/www.joturl.com\/?p=1",
      "template_type": 1
    },
    {
      "error": "FAILED at 2",
      "details": "The chosen alias is not available. (alias1)"
    }
  ]
}

Example 10 (xml)

Request

https://joturl.com/a/i1/urls/shorten?domain_id=06c497bebccc9536b5f55b13732e827d&project_id=6d97731a4989fb6235e967c9a518cd93&bulk=1&info=%5B%7B%22url%22%3A%22https%3A%5C%2F%5C%2Fwww.joturl.com%5C%2F%3Fp%3D0%22,%22alias%22%3A%22alias0%22%7D,%7B%22url%22%3A%22https%3A%5C%2F%5C%2Fwww.joturl.com%5C%2F%3Fp%3D1%22,%22alias%22%3A%22alias1%22%7D,%7B%22url%22%3A%22https%3A%5C%2F%5C%2Fwww.joturl.com%5C%2F%3Fp%3D2%22,%22alias%22%3A%22alias1%22%7D%5D&format=xml

Query parameters

 domain_id = 06c497bebccc9536b5f55b13732e827d
project_id = 6d97731a4989fb6235e967c9a518cd93
      bulk = 1
      info = [{"url":"https:\/\/www.joturl.com\/?p=0","alias":"alias0"},{"url":"https:\/\/www.joturl.com\/?p=1","alias":"alias1"},{"url":"https:\/\/www.joturl.com\/?p=2","alias":"alias1"}]
    format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <i0>
      <id>6721cd606ae63e327e58704d3ea68ba5</id>  
      <alias>alias0</alias>  
      <domain_id>e4f5789ae959f47960e9085fe383f8a6</domain_id>  
      <domain_host>my.custom.domain</domain_host>  
      <domain_nickname></domain_nickname>  
      <project_id>c938d97fb333d4b1fbf906b760afa29b</project_id>  
      <project_name>project name</project_name>  
      <short_url>//my.custom.domain/alias0</short_url>  
      <long_url>https://www.joturl.com/?p=0</long_url>  
      <template_type>1</template_type>  
    </i0>  
    <i1>
      <id>df37738f53598586292942fa4ab5c2d5</id>  
      <alias>alias1</alias>  
      <domain_id>c162847cfbcbc6ebb9db08f43272b34a</domain_id>  
      <domain_host>my.custom.domain</domain_host>  
      <domain_nickname></domain_nickname>  
      <project_id>f2971419c7a5e2d5bed201d7483a0c35</project_id>  
      <project_name>project name</project_name>  
      <short_url>//my.custom.domain/alias1</short_url>  
      <long_url>https://www.joturl.com/?p=1</long_url>  
      <template_type>1</template_type>  
    </i1>  
    <i2>
      <error>FAILED at 2</error>  
      <details>The chosen alias is not available. (alias1)</details>  
    </i2>  
  </result>  
</response>

Example 11 (txt)

Request

https://joturl.com/a/i1/urls/shorten?domain_id=06c497bebccc9536b5f55b13732e827d&project_id=6d97731a4989fb6235e967c9a518cd93&bulk=1&info=%5B%7B%22url%22%3A%22https%3A%5C%2F%5C%2Fwww.joturl.com%5C%2F%3Fp%3D0%22,%22alias%22%3A%22alias0%22%7D,%7B%22url%22%3A%22https%3A%5C%2F%5C%2Fwww.joturl.com%5C%2F%3Fp%3D1%22,%22alias%22%3A%22alias1%22%7D,%7B%22url%22%3A%22https%3A%5C%2F%5C%2Fwww.joturl.com%5C%2F%3Fp%3D2%22,%22alias%22%3A%22alias1%22%7D%5D&format=txt

Query parameters

 domain_id = 06c497bebccc9536b5f55b13732e827d
project_id = 6d97731a4989fb6235e967c9a518cd93
      bulk = 1
      info = [{"url":"https:\/\/www.joturl.com\/?p=0","alias":"alias0"},{"url":"https:\/\/www.joturl.com\/?p=1","alias":"alias1"},{"url":"https:\/\/www.joturl.com\/?p=2","alias":"alias1"}]
    format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_0_id=6721cd606ae63e327e58704d3ea68ba5
result_0_alias=alias0
result_0_domain_id=e4f5789ae959f47960e9085fe383f8a6
result_0_domain_host=my.custom.domain
result_0_domain_nickname=
result_0_project_id=c938d97fb333d4b1fbf906b760afa29b
result_0_project_name=project name
result_0_short_url=//my.custom.domain/alias0
result_0_long_url=https://www.joturl.com/?p=0
result_0_template_type=1
result_1_id=df37738f53598586292942fa4ab5c2d5
result_1_alias=alias1
result_1_domain_id=c162847cfbcbc6ebb9db08f43272b34a
result_1_domain_host=my.custom.domain
result_1_domain_nickname=
result_1_project_id=f2971419c7a5e2d5bed201d7483a0c35
result_1_project_name=project name
result_1_short_url=//my.custom.domain/alias1
result_1_long_url=https://www.joturl.com/?p=1
result_1_template_type=1
result_2_error=FAILED at 2
result_2_details=The chosen alias is not available. (alias1)

Example 12 (plain)

Request

https://joturl.com/a/i1/urls/shorten?domain_id=06c497bebccc9536b5f55b13732e827d&project_id=6d97731a4989fb6235e967c9a518cd93&bulk=1&info=%5B%7B%22url%22%3A%22https%3A%5C%2F%5C%2Fwww.joturl.com%5C%2F%3Fp%3D0%22,%22alias%22%3A%22alias0%22%7D,%7B%22url%22%3A%22https%3A%5C%2F%5C%2Fwww.joturl.com%5C%2F%3Fp%3D1%22,%22alias%22%3A%22alias1%22%7D,%7B%22url%22%3A%22https%3A%5C%2F%5C%2Fwww.joturl.com%5C%2F%3Fp%3D2%22,%22alias%22%3A%22alias1%22%7D%5D&format=plain

Query parameters

 domain_id = 06c497bebccc9536b5f55b13732e827d
project_id = 6d97731a4989fb6235e967c9a518cd93
      bulk = 1
      info = [{"url":"https:\/\/www.joturl.com\/?p=0","alias":"alias0"},{"url":"https:\/\/www.joturl.com\/?p=1","alias":"alias1"},{"url":"https:\/\/www.joturl.com\/?p=2","alias":"alias1"}]
    format = plain

Response

//my.custom.domain/alias0
//my.custom.domain/alias1
FAILED at 2
The chosen alias is not available. (alias1)
Optional parameters
parameterdescriptionmax length
aliasSTRINGavailable only when bulk = 0 - alias for the tracking link, if not specified a random and unique alias will be generated. The alias must be at least 3 characters among lower-case letters a-z, numbers 0-9, minus -, underscore _510
bulkBOOLEAN1 to enable "bulk shorten" mode (default: 0)
domain_idIDID of the domain for the tracking link(s), if not specified the default domain for the user will be used
embed_codeHTMLembed code for the JotBars
infoJSONrequired when bulk = 1 - information for creating tracking links, is a JSON like this [{"url": "destination URL 1", "alias": "alias 1"}, ...], a maximum of 100 elements are allowed
long_urlSTRINGrequired when bulk = 0 - destination URL for the tracking link4000
notesSTRINGnotes for the tracking link255
project_idIDID of the project where the tracking link(s) will be put in, if not specified the default project is used
tagsARRAYcomma-separated list of tags for the tracking link
video_durationSTRINGif the embed code contains a video, this parameter can be used to specify the video duration
Return values
parameterdescription
aliasalias for the tracking link
domain_hostdomain used to create the tracking link
domain_idID of the domain used to create the tracking link
domain_nicknamenickname of the short url domain
idID of the created tracking link
long_urldestination URL for the tracking link
notesonly returned when bulk = 0 - notes for the tracking link
project_idID of the project where the tracking link was created
project_namename of the project where the tracking link was created
short_urlshort URL for the tracking link
tagsonly returned when bulk = 0 - space-separated list of tags associated to the tracking link

/urls/suggest

access: [READ]

Given a domain, suggests a specific number of aliases.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/suggest?number_alias=3&domain_id=95b7688a3e6327a73345ce2da3ce6c89

Query parameters

number_alias = 3
   domain_id = 95b7688a3e6327a73345ce2da3ce6c89

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": [
      "a8f3",
      "85fe9",
      "b53bc5"
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/suggest?number_alias=3&domain_id=95b7688a3e6327a73345ce2da3ce6c89&format=xml

Query parameters

number_alias = 3
   domain_id = 95b7688a3e6327a73345ce2da3ce6c89
      format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <i0>a8f3</i0>  
      <i1>85fe9</i1>  
      <i2>b53bc5</i2>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/suggest?number_alias=3&domain_id=95b7688a3e6327a73345ce2da3ce6c89&format=txt

Query parameters

number_alias = 3
   domain_id = 95b7688a3e6327a73345ce2da3ce6c89
      format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_0=a8f3
result_data_1=85fe9
result_data_2=b53bc5

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/suggest?number_alias=3&domain_id=95b7688a3e6327a73345ce2da3ce6c89&format=plain

Query parameters

number_alias = 3
   domain_id = 95b7688a3e6327a73345ce2da3ce6c89
      format = plain

Response

a8f3
85fe9
b53bc5
Required parameters
parameterdescription
domain_idIDID of the domain where to suggest a new and unique alias
Optional parameters
parameterdescriptionmax length
aliasSTRINGbase for the alias to suggest510
number_aliasSTRINGnumber of aliases to suggest, default 1, maximum 3
Return values
parameterdescription
datasuggested unique aliases

/urls/tags

/urls/tags/add

access: [WRITE]

Add a list of tags to a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/tags/add?url_id=2366dda504dcb19c8275d9a64f99e0ec&tags=test,tag,api

Query parameters

url_id = 2366dda504dcb19c8275d9a64f99e0ec
  tags = test,tag,api

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "added": 3
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/tags/add?url_id=2366dda504dcb19c8275d9a64f99e0ec&tags=test,tag,api&format=xml

Query parameters

url_id = 2366dda504dcb19c8275d9a64f99e0ec
  tags = test,tag,api
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <added>3</added>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/tags/add?url_id=2366dda504dcb19c8275d9a64f99e0ec&tags=test,tag,api&format=txt

Query parameters

url_id = 2366dda504dcb19c8275d9a64f99e0ec
  tags = test,tag,api
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_added=3

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/tags/add?url_id=2366dda504dcb19c8275d9a64f99e0ec&tags=test,tag,api&format=plain

Query parameters

url_id = 2366dda504dcb19c8275d9a64f99e0ec
  tags = test,tag,api
format = plain

Response

3
Required parameters
parameterdescription
tagsARRAYcomma-separated list of tags, these tags will be added to the previous tags
url_idIDID of the tracking link
Return values
parameterdescription
addednumner of added tags, it could be 0 if all passed tags are already associated with the tracking link

/urls/tags/clone

access: [WRITE]

Clone tags from a tracking link to another.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/tags/clone?from_url_id=2178ca81ba5dab80b2e23d2df5df2a0f&to_url_id=6cffe3062777823a38043ea3a7edc9d7

Query parameters

from_url_id = 2178ca81ba5dab80b2e23d2df5df2a0f
  to_url_id = 6cffe3062777823a38043ea3a7edc9d7

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "cloned": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/tags/clone?from_url_id=2178ca81ba5dab80b2e23d2df5df2a0f&to_url_id=6cffe3062777823a38043ea3a7edc9d7&format=xml

Query parameters

from_url_id = 2178ca81ba5dab80b2e23d2df5df2a0f
  to_url_id = 6cffe3062777823a38043ea3a7edc9d7
     format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <cloned>1</cloned>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/tags/clone?from_url_id=2178ca81ba5dab80b2e23d2df5df2a0f&to_url_id=6cffe3062777823a38043ea3a7edc9d7&format=txt

Query parameters

from_url_id = 2178ca81ba5dab80b2e23d2df5df2a0f
  to_url_id = 6cffe3062777823a38043ea3a7edc9d7
     format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_cloned=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/tags/clone?from_url_id=2178ca81ba5dab80b2e23d2df5df2a0f&to_url_id=6cffe3062777823a38043ea3a7edc9d7&format=plain

Query parameters

from_url_id = 2178ca81ba5dab80b2e23d2df5df2a0f
  to_url_id = 6cffe3062777823a38043ea3a7edc9d7
     format = plain

Response

1
Required parameters
parameterdescription
from_url_idIDID of the tracking link you want to copy tags from
to_url_idIDID of the tracking link you want to copy tags to
Return values
parameterdescription
cloned1 on success, 0 otherwise

/urls/tags/count

access: [READ]

This method returns the number of tags.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/tags/count?url_id=9165bd017038c4f8d56904f923cb6d50

Query parameters

url_id = 9165bd017038c4f8d56904f923cb6d50

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 2
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/tags/count?url_id=9165bd017038c4f8d56904f923cb6d50&format=xml

Query parameters

url_id = 9165bd017038c4f8d56904f923cb6d50
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>2</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/tags/count?url_id=9165bd017038c4f8d56904f923cb6d50&format=txt

Query parameters

url_id = 9165bd017038c4f8d56904f923cb6d50
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=2

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/tags/count?url_id=9165bd017038c4f8d56904f923cb6d50&format=plain

Query parameters

url_id = 9165bd017038c4f8d56904f923cb6d50
format = plain

Response

2
Optional parameters
parameterdescription
searchSTRINGfilters tags to be extracted by searching them
url_idIDID of the tracking link from which to extract the tags
Return values
parameterdescription
countnumber of (filtered) tags

/urls/tags/delete

access: [WRITE]

This method deletes the relationship between a tag and an url. If the tag has no reference with others url, the tag will be deleted. Return 1 if the operation succeeds or 0 otherwise.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/tags/delete?url_id=e2d151c3eb34377f3a01cd391a9ad6f4&tag=tag

Query parameters

url_id = e2d151c3eb34377f3a01cd391a9ad6f4
   tag = tag

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/tags/delete?url_id=e2d151c3eb34377f3a01cd391a9ad6f4&tag=tag&format=xml

Query parameters

url_id = e2d151c3eb34377f3a01cd391a9ad6f4
   tag = tag
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/tags/delete?url_id=e2d151c3eb34377f3a01cd391a9ad6f4&tag=tag&format=txt

Query parameters

url_id = e2d151c3eb34377f3a01cd391a9ad6f4
   tag = tag
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/tags/delete?url_id=e2d151c3eb34377f3a01cd391a9ad6f4&tag=tag&format=plain

Query parameters

url_id = e2d151c3eb34377f3a01cd391a9ad6f4
   tag = tag
format = plain

Response

1
Required parameters
parameterdescription
tagSTRINGtag to remove
url_idIDID of the tracking link from which to remove a tag
Return values
parameterdescription
deleted1 on success, 0 otherwise

/urls/tags/edit

access: [WRITE]

Edit tags for a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/tags/edit?url_id=3b279346e8fac8bc0047c3d69d7c0668&tags=test,tag,api

Query parameters

url_id = 3b279346e8fac8bc0047c3d69d7c0668
  tags = test,tag,api

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "edited": 3,
    "url_id": "3b279346e8fac8bc0047c3d69d7c0668",
    "tags": "test,tag,api"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/tags/edit?url_id=3b279346e8fac8bc0047c3d69d7c0668&tags=test,tag,api&format=xml

Query parameters

url_id = 3b279346e8fac8bc0047c3d69d7c0668
  tags = test,tag,api
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <edited>3</edited>  
    <url_id>3b279346e8fac8bc0047c3d69d7c0668</url_id>  
    <tags>test,tag,api</tags>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/tags/edit?url_id=3b279346e8fac8bc0047c3d69d7c0668&tags=test,tag,api&format=txt

Query parameters

url_id = 3b279346e8fac8bc0047c3d69d7c0668
  tags = test,tag,api
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_edited=3
result_url_id=3b279346e8fac8bc0047c3d69d7c0668
result_tags=test,tag,api

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/tags/edit?url_id=3b279346e8fac8bc0047c3d69d7c0668&tags=test,tag,api&format=plain

Query parameters

url_id = 3b279346e8fac8bc0047c3d69d7c0668
  tags = test,tag,api
format = plain

Response

3
3b279346e8fac8bc0047c3d69d7c0668
test,tag,api
Required parameters
parameterdescription
url_idIDID of the tracking link
Optional parameters
parameterdescription
tagsARRAYcomma-separated list of tags, this list will completely replace previous tags (if empty all tags are removed)
Return values
parameterdescription
addednumber of added tags
deletednumber of deleted tags
editednumber of operations (add+delete) on tags
tagscomma-separated list of tags
url_idecho back of parameter url_id

/urls/tags/list

access: [READ]

This method returns a list of tags related to an url, the data returned are specified in a comma separated input called fields.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/tags/list?url_id=41c8bdc2cda1002cdce1590fea2c5829

Query parameters

url_id = 41c8bdc2cda1002cdce1590fea2c5829

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 2,
    "data": [
      {
        "tag": "tag1"
      },
      {
        "tag": "tag2"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/tags/list?url_id=41c8bdc2cda1002cdce1590fea2c5829&format=xml

Query parameters

url_id = 41c8bdc2cda1002cdce1590fea2c5829
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>2</count>  
    <data>
      <i0>
        <tag>tag1</tag>  
      </i0>  
      <i1>
        <tag>tag2</tag>  
      </i1>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/tags/list?url_id=41c8bdc2cda1002cdce1590fea2c5829&format=txt

Query parameters

url_id = 41c8bdc2cda1002cdce1590fea2c5829
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=2
result_data_0_tag=tag1
result_data_1_tag=tag2

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/tags/list?url_id=41c8bdc2cda1002cdce1590fea2c5829&format=plain

Query parameters

url_id = 41c8bdc2cda1002cdce1590fea2c5829
format = plain

Response

2
tag1
tag2
Optional parameters
parameterdescription
lengthINTEGERextracts this number of tags (maxmimum allowed: 100)
searchSTRINGfilters tags to be extracted by searching them
startINTEGERstarts to extract tags from this position
url_idIDID of the tracking link from which to extract the tags
Return values
parameterdescription
dataarray containing information on tags, returned information depends on the fields parameter.

/urls/timing

/urls/timing/clone

access: [WRITE]

Clone a timing configuration from a tracking link to another.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/timing/clone?from_url_id=c3cece857da1b877d0f903330faeff76&to_url_id=c1c352c8cfcfa1738d77d8c423ea4b37

Query parameters

from_url_id = c3cece857da1b877d0f903330faeff76
  to_url_id = c1c352c8cfcfa1738d77d8c423ea4b37

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "cloned": 0
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/timing/clone?from_url_id=c3cece857da1b877d0f903330faeff76&to_url_id=c1c352c8cfcfa1738d77d8c423ea4b37&format=xml

Query parameters

from_url_id = c3cece857da1b877d0f903330faeff76
  to_url_id = c1c352c8cfcfa1738d77d8c423ea4b37
     format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <cloned>0</cloned>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/timing/clone?from_url_id=c3cece857da1b877d0f903330faeff76&to_url_id=c1c352c8cfcfa1738d77d8c423ea4b37&format=txt

Query parameters

from_url_id = c3cece857da1b877d0f903330faeff76
  to_url_id = c1c352c8cfcfa1738d77d8c423ea4b37
     format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_cloned=0

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/timing/clone?from_url_id=c3cece857da1b877d0f903330faeff76&to_url_id=c1c352c8cfcfa1738d77d8c423ea4b37&format=plain

Query parameters

from_url_id = c3cece857da1b877d0f903330faeff76
  to_url_id = c1c352c8cfcfa1738d77d8c423ea4b37
     format = plain

Response

0
Required parameters
parameterdescription
from_url_idIDID of the tracking link you want to copy timing configuration from
to_url_idIDID of the tracking link you want to copy timing configuration to
Return values
parameterdescription
cloned1 on success, 0 otherwise

/urls/timing/delete

access: [WRITE]

Delete the timing configuration of a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/timing/delete?id=e1772dc6d84605011bc33d54c7326873

Query parameters

id = e1772dc6d84605011bc33d54c7326873

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/timing/delete?id=e1772dc6d84605011bc33d54c7326873&format=xml

Query parameters

    id = e1772dc6d84605011bc33d54c7326873
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/timing/delete?id=e1772dc6d84605011bc33d54c7326873&format=txt

Query parameters

    id = e1772dc6d84605011bc33d54c7326873
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/timing/delete?id=e1772dc6d84605011bc33d54c7326873&format=plain

Query parameters

    id = e1772dc6d84605011bc33d54c7326873
format = plain

Response

1
Required parameters
parameterdescription
idIDID of the tracking link from which to remove a timing configuration
Return values
parameterdescription
deleted1 on success, 0 otherwise

/urls/timing/edit

access: [WRITE]

Given a short URL, defines a validity time range. It is possible to define the start datetime, the expire datetime and the URL to be used after expiration. This method is available only to certain user profiles.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/timing/edit?id=a6981c5f1013b26e2dd61c2b9c7d1a5f&valid_from=2025-05-28+16%3A53%3A15&valid_to=2026-06-27+16%3A53%3A15&valid_after_url=&delete_after_expiration=1

Query parameters

                     id = a6981c5f1013b26e2dd61c2b9c7d1a5f
             valid_from = 2025-05-28 16:53:15
               valid_to = 2026-06-27 16:53:15
        valid_after_url = 
delete_after_expiration = 1

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "valid_from": "2025-05-28 16:53:15",
    "valid_to": "2026-06-27 16:53:15",
    "valid_after_url": "",
    "delete_after_expiration": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/timing/edit?id=a6981c5f1013b26e2dd61c2b9c7d1a5f&valid_from=2025-05-28+16%3A53%3A15&valid_to=2026-06-27+16%3A53%3A15&valid_after_url=&delete_after_expiration=1&format=xml

Query parameters

                     id = a6981c5f1013b26e2dd61c2b9c7d1a5f
             valid_from = 2025-05-28 16:53:15
               valid_to = 2026-06-27 16:53:15
        valid_after_url = 
delete_after_expiration = 1
                 format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <valid_from>2025-05-28 16:53:15</valid_from>  
    <valid_to>2026-06-27 16:53:15</valid_to>  
    <valid_after_url></valid_after_url>  
    <delete_after_expiration>1</delete_after_expiration>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/timing/edit?id=a6981c5f1013b26e2dd61c2b9c7d1a5f&valid_from=2025-05-28+16%3A53%3A15&valid_to=2026-06-27+16%3A53%3A15&valid_after_url=&delete_after_expiration=1&format=txt

Query parameters

                     id = a6981c5f1013b26e2dd61c2b9c7d1a5f
             valid_from = 2025-05-28 16:53:15
               valid_to = 2026-06-27 16:53:15
        valid_after_url = 
delete_after_expiration = 1
                 format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_valid_from=2025-05-28 16:53:15
result_valid_to=2026-06-27 16:53:15
result_valid_after_url=
result_delete_after_expiration=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/timing/edit?id=a6981c5f1013b26e2dd61c2b9c7d1a5f&valid_from=2025-05-28+16%3A53%3A15&valid_to=2026-06-27+16%3A53%3A15&valid_after_url=&delete_after_expiration=1&format=plain

Query parameters

                     id = a6981c5f1013b26e2dd61c2b9c7d1a5f
             valid_from = 2025-05-28 16:53:15
               valid_to = 2026-06-27 16:53:15
        valid_after_url = 
delete_after_expiration = 1
                 format = plain

Response

2025-05-28 16:53:15
2026-06-27 16:53:15

1
Required parameters
parameterdescription
idIDID of the tracking link
Optional parameters
parameterdescriptionmax length
delete_after_expirationBOOLEAN1 to delete the tracking link after valid_to
valid_after_urlURLURL to be used after valid_to4000
valid_fromDATETIME/EMPTYthe tracking link is valid from this date/time, before this date/time our engine returns a 404 error if someone tries to navigate to this tracking link; if empty or null it means "valid from now"
valid_toDATETIME/EMPTYthe tracking link is valid until this date/time, after this date/time our engine returns a 404 error if delete_after_expiration = 1 otherwise redirects to valid_after_url; if empty or null it means "valid forever"
Return values
parameterdescription
delete_after_expirationNA
valid_after_urlNA
valid_fromNA
valid_toNA

/urls/timing/info

access: [READ]

Returns information on the validity range of a given short URL. This method is available only to certain user profiles.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/timing/info?id=6476ee0df1ba725c8778d09539334b01

Query parameters

id = 6476ee0df1ba725c8778d09539334b01

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "valid_from": "2025-05-28 16:53:15",
    "valid_to": "2026-06-27 16:53:15",
    "valid_after_url": "",
    "delete_after_expiration": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/timing/info?id=6476ee0df1ba725c8778d09539334b01&format=xml

Query parameters

    id = 6476ee0df1ba725c8778d09539334b01
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <valid_from>2025-05-28 16:53:15</valid_from>  
    <valid_to>2026-06-27 16:53:15</valid_to>  
    <valid_after_url></valid_after_url>  
    <delete_after_expiration>1</delete_after_expiration>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/timing/info?id=6476ee0df1ba725c8778d09539334b01&format=txt

Query parameters

    id = 6476ee0df1ba725c8778d09539334b01
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_valid_from=2025-05-28 16:53:15
result_valid_to=2026-06-27 16:53:15
result_valid_after_url=
result_delete_after_expiration=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/timing/info?id=6476ee0df1ba725c8778d09539334b01&format=plain

Query parameters

    id = 6476ee0df1ba725c8778d09539334b01
format = plain

Response

2025-05-28 16:53:15
2026-06-27 16:53:15

1
Required parameters
parameterdescription
idIDID of the tracking link
Return values
parameterdescription
delete_after_expiration1 to delete the tracking link after valid_to
valid_after_urlURL to be used after valid_to
valid_fromthe tracking link is valid from this date/time, before this date/time our engine returns a 404 error if someone tries to navigate to this tracking link; if empty or null it means "valid from now"
valid_tothe tracking link is valid until this date/time, after this date/time our engine returns a 404 error if delete_after_expiration = 1 otherwise redirects to valid_after_url; if empty or null it means "valid forever"

/urls/vcards

/urls/vcards/property

access: [READ]

Returns limits for vCards.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/vcards/property

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "max_vcard_size": 70000,
    "max_vcard_image_size": 30000,
    "supported_fields": {
      "name": [
        "namePrefix",
        "firstName",
        "middleName",
        "lastName",
        "nameSuffix"
      ],
      "work": [
        "title",
        "role",
        "organization",
        "department",
        "workURL"
      ],
      "emails": [
        "email",
        "workEmail"
      ],
      "phones": [
        "homePhone",
        "workPhone",
        "cellPhone",
        "pagerPhone",
        "homeFax",
        "workFax"
      ],
      "homeAdd": [
        "homeAddLabel",
        "homeAddStreet",
        "homeAddCity",
        "homeAddState",
        "homeAddPostalCode",
        "homeAddCountry"
      ],
      "workAdd": [
        "workAddLabel",
        "workAddStreet",
        "workAddCity",
        "workAddState",
        "workAddPostalCode",
        "workAddCountry"
      ],
      "personal": [
        "birthdayDay",
        "birthdayMonth",
        "birthdayYear",
        "anniversaryDay",
        "anniversaryMonth",
        "anniversaryYear",
        "personalURL",
        "gender"
      ],
      "images": [
        "photo",
        "embed_photo",
        "embedded_photo",
        "logo",
        "embed_logo",
        "embedded_logo"
      ],
      "socials": [
        "linkedin",
        "twitter",
        "facebook",
        "instagram",
        "youtube",
        "tiktok"
      ],
      "other": [
        "note",
        "uid"
      ]
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/vcards/property?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <max_vcard_size>70000</max_vcard_size>  
    <max_vcard_image_size>30000</max_vcard_image_size>  
    <supported_fields>
      <name>
        <i0>namePrefix</i0>  
        <i1>firstName</i1>  
        <i2>middleName</i2>  
        <i3>lastName</i3>  
        <i4>nameSuffix</i4>  
      </name>  
      <work>
        <i0>title</i0>  
        <i1>role</i1>  
        <i2>organization</i2>  
        <i3>department</i3>  
        <i4>workURL</i4>  
      </work>  
      <emails>
        <i0>email</i0>  
        <i1>workEmail</i1>  
      </emails>  
      <phones>
        <i0>homePhone</i0>  
        <i1>workPhone</i1>  
        <i2>cellPhone</i2>  
        <i3>pagerPhone</i3>  
        <i4>homeFax</i4>  
        <i5>workFax</i5>  
      </phones>  
      <homeAdd>
        <i0>homeAddLabel</i0>  
        <i1>homeAddStreet</i1>  
        <i2>homeAddCity</i2>  
        <i3>homeAddState</i3>  
        <i4>homeAddPostalCode</i4>  
        <i5>homeAddCountry</i5>  
      </homeAdd>  
      <workAdd>
        <i0>workAddLabel</i0>  
        <i1>workAddStreet</i1>  
        <i2>workAddCity</i2>  
        <i3>workAddState</i3>  
        <i4>workAddPostalCode</i4>  
        <i5>workAddCountry</i5>  
      </workAdd>  
      <personal>
        <i0>birthdayDay</i0>  
        <i1>birthdayMonth</i1>  
        <i2>birthdayYear</i2>  
        <i3>anniversaryDay</i3>  
        <i4>anniversaryMonth</i4>  
        <i5>anniversaryYear</i5>  
        <i6>personalURL</i6>  
        <i7>gender</i7>  
      </personal>  
      <images>
        <i0>photo</i0>  
        <i1>embed_photo</i1>  
        <i2>embedded_photo</i2>  
        <i3>logo</i3>  
        <i4>embed_logo</i4>  
        <i5>embedded_logo</i5>  
      </images>  
      <socials>
        <i0>linkedin</i0>  
        <i1>twitter</i1>  
        <i2>facebook</i2>  
        <i3>instagram</i3>  
        <i4>youtube</i4>  
        <i5>tiktok</i5>  
      </socials>  
      <other>
        <i0>note</i0>  
        <i1>uid</i1>  
      </other>  
    </supported_fields>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/vcards/property?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_max_vcard_size=70000
result_max_vcard_image_size=30000
result_supported_fields_name_0=namePrefix
result_supported_fields_name_1=firstName
result_supported_fields_name_2=middleName
result_supported_fields_name_3=lastName
result_supported_fields_name_4=nameSuffix
result_supported_fields_work_0=title
result_supported_fields_work_1=role
result_supported_fields_work_2=organization
result_supported_fields_work_3=department
result_supported_fields_work_4=workURL
result_supported_fields_emails_0=email
result_supported_fields_emails_1=workEmail
result_supported_fields_phones_0=homePhone
result_supported_fields_phones_1=workPhone
result_supported_fields_phones_2=cellPhone
result_supported_fields_phones_3=pagerPhone
result_supported_fields_phones_4=homeFax
result_supported_fields_phones_5=workFax
result_supported_fields_homeAdd_0=homeAddLabel
result_supported_fields_homeAdd_1=homeAddStreet
result_supported_fields_homeAdd_2=homeAddCity
result_supported_fields_homeAdd_3=homeAddState
result_supported_fields_homeAdd_4=homeAddPostalCode
result_supported_fields_homeAdd_5=homeAddCountry
result_supported_fields_workAdd_0=workAddLabel
result_supported_fields_workAdd_1=workAddStreet
result_supported_fields_workAdd_2=workAddCity
result_supported_fields_workAdd_3=workAddState
result_supported_fields_workAdd_4=workAddPostalCode
result_supported_fields_workAdd_5=workAddCountry
result_supported_fields_personal_0=birthdayDay
result_supported_fields_personal_1=birthdayMonth
result_supported_fields_personal_2=birthdayYear
result_supported_fields_personal_3=anniversaryDay
result_supported_fields_personal_4=anniversaryMonth
result_supported_fields_personal_5=anniversaryYear
result_supported_fields_personal_6=personalURL
result_supported_fields_personal_7=gender
result_supported_fields_images_0=photo
result_supported_fields_images_1=embed_photo
result_supported_fields_images_2=embedded_photo
result_supported_fields_images_3=logo
result_supported_fields_images_4=embed_logo
result_supported_fields_images_5=embedded_logo
result_supported_fields_socials_0=linkedin
result_supported_fields_socials_1=twitter
result_supported_fields_socials_2=facebook
result_supported_fields_socials_3=instagram
result_supported_fields_socials_4=youtube
result_supported_fields_socials_5=tiktok
result_supported_fields_other_0=note
result_supported_fields_other_1=uid

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/vcards/property?format=plain

Query parameters

format = plain

Response

70000
30000
namePrefix
firstName
middleName
lastName
nameSuffix
title
role
organization
department
workURL
email
workEmail
homePhone
workPhone
cellPhone
pagerPhone
homeFax
workFax
homeAddLabel
homeAddStreet
homeAddCity
homeAddState
homeAddPostalCode
homeAddCountry
workAddLabel
workAddStreet
workAddCity
workAddState
workAddPostalCode
workAddCountry
birthdayDay
birthdayMonth
birthdayYear
anniversaryDay
anniversaryMonth
anniversaryYear
personalURL
gender
photo
embed_photo
embedded_photo
logo
embed_logo
embedded_logo
linkedin
twitter
facebook
instagram
youtube
tiktok
note
uid
Return values
parameterdescription
max_vcard_image_sizemaximum number of bytes allowed in vCard images
max_vcard_sizemaximum number of bytes allowed in the vCard
supported_fieldslist of fields supported in the vCard divided by groups

/urls/watchdogs

/urls/watchdogs/alerts

/urls/watchdogs/alerts/delete

access: [WRITE]

Reset watchdog's alerts for a given array of URL.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/watchdogs/alerts/delete?count=3&ids=91aa9dfce91ed3e3ebf21c4bfb9c0571,2326ca4394585c38b12a63ccf7253d0c,eb806b04b173afe8c634f0749b6cd596

Query parameters

count = 3
  ids = 91aa9dfce91ed3e3ebf21c4bfb9c0571,2326ca4394585c38b12a63ccf7253d0c,eb806b04b173afe8c634f0749b6cd596

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 3,
    "ids": "91aa9dfce91ed3e3ebf21c4bfb9c0571,2326ca4394585c38b12a63ccf7253d0c,eb806b04b173afe8c634f0749b6cd596"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/watchdogs/alerts/delete?count=3&ids=91aa9dfce91ed3e3ebf21c4bfb9c0571,2326ca4394585c38b12a63ccf7253d0c,eb806b04b173afe8c634f0749b6cd596&format=xml

Query parameters

 count = 3
   ids = 91aa9dfce91ed3e3ebf21c4bfb9c0571,2326ca4394585c38b12a63ccf7253d0c,eb806b04b173afe8c634f0749b6cd596
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>3</count>  
    <ids>91aa9dfce91ed3e3ebf21c4bfb9c0571,2326ca4394585c38b12a63ccf7253d0c,eb806b04b173afe8c634f0749b6cd596</ids>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/watchdogs/alerts/delete?count=3&ids=91aa9dfce91ed3e3ebf21c4bfb9c0571,2326ca4394585c38b12a63ccf7253d0c,eb806b04b173afe8c634f0749b6cd596&format=txt

Query parameters

 count = 3
   ids = 91aa9dfce91ed3e3ebf21c4bfb9c0571,2326ca4394585c38b12a63ccf7253d0c,eb806b04b173afe8c634f0749b6cd596
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=3
result_ids=91aa9dfce91ed3e3ebf21c4bfb9c0571,2326ca4394585c38b12a63ccf7253d0c,eb806b04b173afe8c634f0749b6cd596

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/watchdogs/alerts/delete?count=3&ids=91aa9dfce91ed3e3ebf21c4bfb9c0571,2326ca4394585c38b12a63ccf7253d0c,eb806b04b173afe8c634f0749b6cd596&format=plain

Query parameters

 count = 3
   ids = 91aa9dfce91ed3e3ebf21c4bfb9c0571,2326ca4394585c38b12a63ccf7253d0c,eb806b04b173afe8c634f0749b6cd596
format = plain

Response

3
91aa9dfce91ed3e3ebf21c4bfb9c0571,2326ca4394585c38b12a63ccf7253d0c,eb806b04b173afe8c634f0749b6cd596
Required parameters
parameterdescription
idsARRAY_OF_IDScomma-separated list of ID of the tracking links from which to reset watchdog's alerts
Return values
parameterdescription
countnumber of deleted alerts
idsecho back of the ids imput parameters
/urls/watchdogs/alerts/info

access: [READ]

Returns watchdog's alerts for a given short URL.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/watchdogs/alerts/info?id=32a32fcfbe328dc6c930ae381fdb74a3

Query parameters

id = 32a32fcfbe328dc6c930ae381fdb74a3

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": {
      "alerts": [
        {
          "message": "URL redirects to .",
          "occurrencies": 56,
          "date": {
            "from": "2025-06-03 16:53:15",
            "to": "2025-06-27 16:53:15"
          }
        }
      ],
      "browsers": {
        "mobile": [
          {
            "BrowserName": "Openwave Mobile Browser 6.2.3.3.c.1.101",
            "Platform": "Unix sun",
            "MobileDevice": "Samsung"
          },
          "[...]",
          {
            "BrowserName": "DoCoMo 3.0",
            "Platform": "--",
            "MobileDevice": "--"
          }
        ],
        "desktop": [
          {
            "BrowserName": "Google AdSense",
            "Platform": "--"
          },
          "[...]",
          {
            "BrowserName": "Shiretoko Firefox 3.5",
            "Platform": "Linux"
          }
        ]
      },
      "long_url": "https:\/\/www.example.com\/product\/124141255",
      "last_update": "2025-06-04 16:53:15"
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/watchdogs/alerts/info?id=32a32fcfbe328dc6c930ae381fdb74a3&format=xml

Query parameters

    id = 32a32fcfbe328dc6c930ae381fdb74a3
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <alerts>
        <i0>
          <message>URL redirects to .</message>  
          <occurrencies>56</occurrencies>  
          <date>
            <from>2025-06-03 16:53:15</from>  
            <to>2025-06-27 16:53:15</to>  
          </date>  
        </i0>  
      </alerts>  
      <browsers>
        <mobile>
          <i0>
            <BrowserName>Openwave Mobile Browser 6.2.3.3.c.1.101</BrowserName>  
            <Platform>Unix sun</Platform>  
            <MobileDevice>Samsung</MobileDevice>  
          </i0>  
          <i1>[...]</i1>  
          <i2>
            <BrowserName>DoCoMo 3.0</BrowserName>  
            <Platform>--</Platform>  
            <MobileDevice>--</MobileDevice>  
          </i2>  
        </mobile>  
        <desktop>
          <i0>
            <BrowserName>Google AdSense</BrowserName>  
            <Platform>--</Platform>  
          </i0>  
          <i1>[...]</i1>  
          <i2>
            <BrowserName>Shiretoko Firefox 3.5</BrowserName>  
            <Platform>Linux</Platform>  
          </i2>  
        </desktop>  
      </browsers>  
      <long_url>https://www.example.com/product/124141255</long_url>  
      <last_update>2025-06-04 16:53:15</last_update>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/watchdogs/alerts/info?id=32a32fcfbe328dc6c930ae381fdb74a3&format=txt

Query parameters

    id = 32a32fcfbe328dc6c930ae381fdb74a3
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_alerts_0_message=URL redirects to .
result_data_alerts_0_occurrencies=56
result_data_alerts_0_date_from=2025-06-03 16:53:15
result_data_alerts_0_date_to=2025-06-27 16:53:15
result_data_browsers_mobile_0_BrowserName=Openwave Mobile Browser 6.2.3.3.c.1.101
result_data_browsers_mobile_0_Platform=Unix sun
result_data_browsers_mobile_0_MobileDevice=Samsung
result_data_browsers_mobile_1=[...]
result_data_browsers_mobile_2_BrowserName=DoCoMo 3.0
result_data_browsers_mobile_2_Platform=--
result_data_browsers_mobile_2_MobileDevice=--
result_data_browsers_desktop_0_BrowserName=Google AdSense
result_data_browsers_desktop_0_Platform=--
result_data_browsers_desktop_1=[...]
result_data_browsers_desktop_2_BrowserName=Shiretoko Firefox 3.5
result_data_browsers_desktop_2_Platform=Linux
result_data_long_url=https://www.example.com/product/124141255
result_data_last_update=2025-06-04 16:53:15

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/watchdogs/alerts/info?id=32a32fcfbe328dc6c930ae381fdb74a3&format=plain

Query parameters

    id = 32a32fcfbe328dc6c930ae381fdb74a3
format = plain

Response

URL redirects to .
56
2025-06-03 16:53:15
2025-06-27 16:53:15
Openwave Mobile Browser 6.2.3.3.c.1.101
Unix sun
Samsung
[...]
DoCoMo 3.0
--
--
Google AdSense
--
[...]
Shiretoko Firefox 3.5
Linux
https://www.example.com/product/124141255
2025-06-04 16:53:15
Required parameters
parameterdescription
idIDID of the tracking link
Return values
parameterdescription
dataarray containing information for the alerts

/urls/whatsapps

/urls/whatsapps/clone

access: [WRITE]

Clone the whatsapps configuration from a tracking link to another.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/whatsapps/clone?from_url_id=991ada38fdd20ff5ff25d618bd6effa0&to_url_id=b90d47c943120a6bac07466689a54e36

Query parameters

from_url_id = 991ada38fdd20ff5ff25d618bd6effa0
  to_url_id = b90d47c943120a6bac07466689a54e36

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "cloned": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/whatsapps/clone?from_url_id=991ada38fdd20ff5ff25d618bd6effa0&to_url_id=b90d47c943120a6bac07466689a54e36&format=xml

Query parameters

from_url_id = 991ada38fdd20ff5ff25d618bd6effa0
  to_url_id = b90d47c943120a6bac07466689a54e36
     format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <cloned>1</cloned>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/whatsapps/clone?from_url_id=991ada38fdd20ff5ff25d618bd6effa0&to_url_id=b90d47c943120a6bac07466689a54e36&format=txt

Query parameters

from_url_id = 991ada38fdd20ff5ff25d618bd6effa0
  to_url_id = b90d47c943120a6bac07466689a54e36
     format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_cloned=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/whatsapps/clone?from_url_id=991ada38fdd20ff5ff25d618bd6effa0&to_url_id=b90d47c943120a6bac07466689a54e36&format=plain

Query parameters

from_url_id = 991ada38fdd20ff5ff25d618bd6effa0
  to_url_id = b90d47c943120a6bac07466689a54e36
     format = plain

Response

1
Required parameters
parameterdescription
from_url_idIDID of the tracking link you want to copy the whatsapps configuration from
to_url_idIDID of the tracking link you want to the whatsapps configuration to
Return values
parameterdescription
cloned1 on success, 0 otherwise

/urls/whatsapps/delete

access: [WRITE]

Delete a WhatsUrl configuration for a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/whatsapps/delete?url_id=7da014525f5670c8e1e44d102ef6e733

Query parameters

url_id = 7da014525f5670c8e1e44d102ef6e733

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/whatsapps/delete?url_id=7da014525f5670c8e1e44d102ef6e733&format=xml

Query parameters

url_id = 7da014525f5670c8e1e44d102ef6e733
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/whatsapps/delete?url_id=7da014525f5670c8e1e44d102ef6e733&format=txt

Query parameters

url_id = 7da014525f5670c8e1e44d102ef6e733
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/whatsapps/delete?url_id=7da014525f5670c8e1e44d102ef6e733&format=plain

Query parameters

url_id = 7da014525f5670c8e1e44d102ef6e733
format = plain

Response

1
Required parameters
parameterdescription
idIDID of the tracking link from which to remove a WhatsUrl configuration
Return values
parameterdescription
deleted1 on success, 0 otherwise

/urls/whatsapps/edit

access: [WRITE]

Set WhatsApp settings for a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/whatsapps/edit?id=04e3af7ff75e1dc707a1ffc050ecc904&settings=%7B%22whatsapp_phone%22%3A%221234567890123%22,%22whatsapp_message%22%3A%22This+is+a+text+message%22,%22whatsapp_message_html%22%3A%22This+is+a+text+message%22,%22whatsapp_disclaimer%22%3A1%7D

Query parameters

      id = 04e3af7ff75e1dc707a1ffc050ecc904
settings = {"whatsapp_phone":"1234567890123","whatsapp_message":"This is a text message","whatsapp_message_html":"This is a text message","whatsapp_disclaimer":1}

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "enabled": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/whatsapps/edit?id=04e3af7ff75e1dc707a1ffc050ecc904&settings=%7B%22whatsapp_phone%22%3A%221234567890123%22,%22whatsapp_message%22%3A%22This+is+a+text+message%22,%22whatsapp_message_html%22%3A%22This+is+a+text+message%22,%22whatsapp_disclaimer%22%3A1%7D&format=xml

Query parameters

      id = 04e3af7ff75e1dc707a1ffc050ecc904
settings = {"whatsapp_phone":"1234567890123","whatsapp_message":"This is a text message","whatsapp_message_html":"This is a text message","whatsapp_disclaimer":1}
  format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <enabled>1</enabled>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/whatsapps/edit?id=04e3af7ff75e1dc707a1ffc050ecc904&settings=%7B%22whatsapp_phone%22%3A%221234567890123%22,%22whatsapp_message%22%3A%22This+is+a+text+message%22,%22whatsapp_message_html%22%3A%22This+is+a+text+message%22,%22whatsapp_disclaimer%22%3A1%7D&format=txt

Query parameters

      id = 04e3af7ff75e1dc707a1ffc050ecc904
settings = {"whatsapp_phone":"1234567890123","whatsapp_message":"This is a text message","whatsapp_message_html":"This is a text message","whatsapp_disclaimer":1}
  format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_enabled=1

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/whatsapps/edit?id=04e3af7ff75e1dc707a1ffc050ecc904&settings=%7B%22whatsapp_phone%22%3A%221234567890123%22,%22whatsapp_message%22%3A%22This+is+a+text+message%22,%22whatsapp_message_html%22%3A%22This+is+a+text+message%22,%22whatsapp_disclaimer%22%3A1%7D&format=plain

Query parameters

      id = 04e3af7ff75e1dc707a1ffc050ecc904
settings = {"whatsapp_phone":"1234567890123","whatsapp_message":"This is a text message","whatsapp_message_html":"This is a text message","whatsapp_disclaimer":1}
  format = plain

Response

1
Required parameters
parameterdescription
idIDID of the tracking link
settingsJSONstringified JSON containing the Whatsapp settings
Return values
parameterdescription
enabled1 on success, 0 otherwise

/urls/whatsapps/info

access: [READ]

Get settings for the WhatsApp option.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/whatsapps/info?id=dfd9dc3c2eeaa02800b9318cd118f8ff

Query parameters

id = dfd9dc3c2eeaa02800b9318cd118f8ff

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "compatible": 0
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/urls/whatsapps/info?id=dfd9dc3c2eeaa02800b9318cd118f8ff&format=xml

Query parameters

    id = dfd9dc3c2eeaa02800b9318cd118f8ff
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <compatible>0</compatible>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/urls/whatsapps/info?id=dfd9dc3c2eeaa02800b9318cd118f8ff&format=txt

Query parameters

    id = dfd9dc3c2eeaa02800b9318cd118f8ff
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_compatible=0

Example 4 (plain)

Request

https://joturl.com/a/i1/urls/whatsapps/info?id=dfd9dc3c2eeaa02800b9318cd118f8ff&format=plain

Query parameters

    id = dfd9dc3c2eeaa02800b9318cd118f8ff
format = plain

Response

0
Required parameters
parameterdescription
idIDID of the tracking link
Return values
parameterdescription
settingsarray containing the settings for the WhatsApp option

/users

/users/2fa

/users/2fa/disable

access: [WRITE]

This method disable the 2-factor authentication for the logged in user.

Example 1 (json)

Request

https://joturl.com/a/i1/users/2fa/disable?code=322384

Query parameters

code = 322384

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "enabled": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/2fa/disable?code=322384&format=xml

Query parameters

  code = 322384
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <enabled>1</enabled>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/2fa/disable?code=322384&format=txt

Query parameters

  code = 322384
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_enabled=1

Example 4 (plain)

Request

https://joturl.com/a/i1/users/2fa/disable?code=322384&format=plain

Query parameters

  code = 322384
format = plain

Response

1
Required parameters
parameterdescriptionmax length
codeSTRINGsecurity code given by the authenticator app or one of the backup codes8
Return values
parameterdescription
disabled1 if the 2-factor authentication deactivation was successful, otherwise an error is returned

/users/2fa/enable

access: [WRITE]

This method enable the 2-factor authentication for the logged in user.

Example 1 (json)

Request

https://joturl.com/a/i1/users/2fa/enable?code=322384

Query parameters

code = 322384

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "enabled": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/2fa/enable?code=322384&format=xml

Query parameters

  code = 322384
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <enabled>1</enabled>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/2fa/enable?code=322384&format=txt

Query parameters

  code = 322384
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_enabled=1

Example 4 (plain)

Request

https://joturl.com/a/i1/users/2fa/enable?code=322384&format=plain

Query parameters

  code = 322384
format = plain

Response

1
Required parameters
parameterdescriptionmax length
codeSTRINGsecurity code given by the authenticator app6
Return values
parameterdescription
enabled1 if the 2-factor authentication activation was successful, otherwise an error is returned

/users/2fa/info

access: [READ]

This method returns info on the 2-factor authentication status of the logged in user.

Example 1 (json)

Request

https://joturl.com/a/i1/users/2fa/info

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "enabled": 0,
    "label": "JotUrl - my@email.address",
    "secret": "d3982bfe6e1e3da04db26c43dec8a0fe",
    "uri": "otpauth:\/\/totp\/JotUrl+-+my%40email.address?secret=d3982bfe6e1e3da04db26c43dec8a0fe"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/2fa/info?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <enabled>0</enabled>  
    <label>JotUrl - my@email.address</label>  
    <secret>d3982bfe6e1e3da04db26c43dec8a0fe</secret>  
    <uri>otpauth://totp/JotUrl+-+my%40email.address?secret=d3982bfe6e1e3da04db26c43dec8a0fe</uri>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/2fa/info?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_enabled=0
result_label=JotUrl - my@email.address
result_secret=d3982bfe6e1e3da04db26c43dec8a0fe
result_uri=otpauth://totp/JotUrl+-+my%40email.address?secret=d3982bfe6e1e3da04db26c43dec8a0fe

Example 4 (plain)

Request

https://joturl.com/a/i1/users/2fa/info?format=plain

Query parameters

format = plain

Response

0
JotUrl - my@email.address
d3982bfe6e1e3da04db26c43dec8a0fe
otpauth://totp/JotUrl+-+my%40email.address?secret=d3982bfe6e1e3da04db26c43dec8a0fe
Optional parameters
parameterdescriptionmax length
codeSTRINGsecurity code given by the authenticator app or one of the backup codes8
statusBOOLEAN1 to request only the status without generating/returning 2FA information (default: 0)
Return values
parameterdescription
backup[OPTIONAL] returned only if enabled = 0 or if code is passed, backup codes for the 2-factor authentication
enabled1 if the 2-factor authentication is enabled for the logged in user, 0 otherwise
label[OPTIONAL] returned only if enabled = 0 or if code is passed, this is the label that will be displayed in the authenticator app
secret[OPTIONAL] returned only if enabled = 0 or if code is passed, it is the secret key used by the authenticator app
uri[OPTIONAL] returned only if enabled = 0 or if code is passed, it is the provisioning URI to enable 2-factor authentication

/users/blocked_ips

/users/blocked_ips/add

access: [WRITE]

Add IPs to the block list.

Example 1 (json)

Request

https://joturl.com/a/i1/users/blocked_ips/add?ips=8.8.99.0,8.8.68.%2A

Query parameters

ips = 8.8.99.0,8.8.68.*

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 2
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/blocked_ips/add?ips=8.8.99.0,8.8.68.%2A&format=xml

Query parameters

   ips = 8.8.99.0,8.8.68.*
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>2</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/blocked_ips/add?ips=8.8.99.0,8.8.68.%2A&format=txt

Query parameters

   ips = 8.8.99.0,8.8.68.*
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=2

Example 4 (plain)

Request

https://joturl.com/a/i1/users/blocked_ips/add?ips=8.8.99.0,8.8.68.%2A&format=plain

Query parameters

   ips = 8.8.99.0,8.8.68.*
format = plain

Response

2
Required parameters
parameterdescription
ipsARRAYarray of IPs to add to the block list
Return values
parameterdescription
counttotal number of added IPs

/users/blocked_ips/count

access: [READ]

This method returns the number of blocked IPs.

Example 1 (json)

Request

https://joturl.com/a/i1/users/blocked_ips/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 4
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/blocked_ips/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>4</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/blocked_ips/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=4

Example 4 (plain)

Request

https://joturl.com/a/i1/users/blocked_ips/count?format=plain

Query parameters

format = plain

Response

4
Return values
parameterdescription
counttotal number of blocked IPs

/users/blocked_ips/delete

access: [WRITE]

Delete one or more blocked IPs.

Example 1 (json)

Request

https://joturl.com/a/i1/users/blocked_ips/delete?ips=8.8.253.0,8.8.85.0,8.8.74.0,8.8.16.0,8.8.79.%2A

Query parameters

ips = 8.8.253.0,8.8.85.0,8.8.74.0,8.8.16.0,8.8.79.*

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 5
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/blocked_ips/delete?ips=8.8.253.0,8.8.85.0,8.8.74.0,8.8.16.0,8.8.79.%2A&format=xml

Query parameters

   ips = 8.8.253.0,8.8.85.0,8.8.74.0,8.8.16.0,8.8.79.*
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>5</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/blocked_ips/delete?ips=8.8.253.0,8.8.85.0,8.8.74.0,8.8.16.0,8.8.79.%2A&format=txt

Query parameters

   ips = 8.8.253.0,8.8.85.0,8.8.74.0,8.8.16.0,8.8.79.*
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=5

Example 4 (plain)

Request

https://joturl.com/a/i1/users/blocked_ips/delete?ips=8.8.253.0,8.8.85.0,8.8.74.0,8.8.16.0,8.8.79.%2A&format=plain

Query parameters

   ips = 8.8.253.0,8.8.85.0,8.8.74.0,8.8.16.0,8.8.79.*
format = plain

Response

5
Required parameters
parameterdescription
ipsARRAYarray of blocked IPs to be deleted
Return values
parameterdescription
counttotal number of blocked IPs that have been deleted

/users/blocked_ips/is_blacklisted

access: [WRITE]

This method checks if the IPs in a list are blocked.

Example 1 (json)

Request

https://joturl.com/a/i1/users/blocked_ips/is_blacklisted?ids=8.8.49.0,8.8.101.0,8.8.75.0

Query parameters

ids = 8.8.49.0,8.8.101.0,8.8.75.0

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "ips": {
      "8.8.49.0": {
        "blacklisted": 1
      },
      "8.8.101.0": {
        "blacklisted": 0
      },
      "8.8.75.0": {
        "blacklisted": 0
      }
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/blocked_ips/is_blacklisted?ids=8.8.49.0,8.8.101.0,8.8.75.0&format=xml

Query parameters

   ids = 8.8.49.0,8.8.101.0,8.8.75.0
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <ips>
      <8.8.49.0>
        <blacklisted>1</blacklisted>  
      </8.8.49.0>  
      <8.8.101.0>
        <blacklisted>0</blacklisted>  
      </8.8.101.0>  
      <8.8.75.0>
        <blacklisted>0</blacklisted>  
      </8.8.75.0>  
    </ips>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/blocked_ips/is_blacklisted?ids=8.8.49.0,8.8.101.0,8.8.75.0&format=txt

Query parameters

   ids = 8.8.49.0,8.8.101.0,8.8.75.0
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_ips_8.8.49.0_blacklisted=1
result_ips_8.8.101.0_blacklisted=0
result_ips_8.8.75.0_blacklisted=0

Example 4 (plain)

Request

https://joturl.com/a/i1/users/blocked_ips/is_blacklisted?ids=8.8.49.0,8.8.101.0,8.8.75.0&format=plain

Query parameters

   ids = 8.8.49.0,8.8.101.0,8.8.75.0
format = plain

Response

1
0
0
Required parameters
parameterdescription
ipsARRAYarray of IPs to be checked
Return values
parameterdescription
idsJSON object that contains each valid IP in ips with its check result {"[IP1]":{"blacklisted":"[1&#124;0]"},...,"[IPN]":{"blacklisted":"[1&#124;0]"}}

/users/blocked_ips/list

access: [READ]

This method returns a list of blocked IPs.

Example 1 (json)

Request

https://joturl.com/a/i1/users/blocked_ips/list?fields=ip,count

Query parameters

fields = ip,count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 3,
    "data": [
      "8.8.185.0",
      "8.8.184.0",
      "8.8.120.0",
      "8.8.137.*"
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/blocked_ips/list?fields=ip,count&format=xml

Query parameters

fields = ip,count
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>3</count>  
    <data>
      <i0>8.8.185.0</i0>  
      <i1>8.8.184.0</i1>  
      <i2>8.8.120.0</i2>  
      <i3>8.8.137.*</i3>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/blocked_ips/list?fields=ip,count&format=txt

Query parameters

fields = ip,count
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=3
result_data_0=8.8.185.0
result_data_1=8.8.184.0
result_data_2=8.8.120.0
result_data_3=8.8.137.*

Example 4 (plain)

Request

https://joturl.com/a/i1/users/blocked_ips/list?fields=ip,count&format=plain

Query parameters

fields = ip,count
format = plain

Response

3
8.8.185.0
8.8.184.0
8.8.120.0
8.8.137.*

Example 5 (json)

Request

https://joturl.com/a/i1/users/blocked_ips/list

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": [
      "8.8.71.113",
      "8.8.98.183"
    ]
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/users/blocked_ips/list?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <i0>8.8.71.113</i0>  
      <i1>8.8.98.183</i1>  
    </data>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/users/blocked_ips/list?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_0=8.8.71.113
result_data_1=8.8.98.183

Example 8 (plain)

Request

https://joturl.com/a/i1/users/blocked_ips/list?format=plain

Query parameters

format = plain

Response

8.8.71.113
8.8.98.183
Required parameters
parameterdescription
fieldsARRAYcomma separated list of fields to return, available fields: ip, count
Return values
parameterdescription
count[OPTIONAL] total number of blocked IPs, returned only if count is passed in fields
dataarray containing a list of blocked IPs

/users/captcha

access: [WRITE]

This method emits a captcha.

Example 1 (json)

Request

https://joturl.com/a/i1/users/captcha?captcha=812865fb

Query parameters

captcha = 812865fb

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "captcha": "812865fb",
    "url": "\/a\/i1\/users\/captcha?captcha=812865fb"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/captcha?captcha=812865fb&format=xml

Query parameters

captcha = 812865fb
 format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <captcha>812865fb</captcha>  
    <url>/a/i1/users/captcha?captcha=812865fb</url>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/captcha?captcha=812865fb&format=txt

Query parameters

captcha = 812865fb
 format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_captcha=812865fb
result_url=/a/i1/users/captcha?captcha=812865fb

Example 4 (plain)

Request

https://joturl.com/a/i1/users/captcha?captcha=812865fb&format=plain

Query parameters

captcha = 812865fb
 format = plain

Response

812865fb
/a/i1/users/captcha?captcha=812865fb
Optional parameters
parameterdescription
captchaSTRINGID of the captcha, if it is passed this method returns the corresponding captcha image if valid, otherwise returns an invalid parameter error
Return values
parameterdescription
captchaID of the captcha
urlURL of the captcha image

/users/confirm

access: [WRITE]

This method executes confirm operations.

Example 1 (json)

Request

https://joturl.com/a/i1/users/confirm?info=d1e0efc343f72e8cccf9cc76a6fa9883

Query parameters

info = d1e0efc343f72e8cccf9cc76a6fa9883

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "ok": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/confirm?info=d1e0efc343f72e8cccf9cc76a6fa9883&format=xml

Query parameters

  info = d1e0efc343f72e8cccf9cc76a6fa9883
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <ok>1</ok>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/confirm?info=d1e0efc343f72e8cccf9cc76a6fa9883&format=txt

Query parameters

  info = d1e0efc343f72e8cccf9cc76a6fa9883
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_ok=1

Example 4 (plain)

Request

https://joturl.com/a/i1/users/confirm?info=d1e0efc343f72e8cccf9cc76a6fa9883&format=plain

Query parameters

  info = d1e0efc343f72e8cccf9cc76a6fa9883
format = plain

Response

1
Required parameters
parameterdescription
infoSTRINGconfirm token sent to the user email
Return values
parameterdescription
ok1 on success, otherwise a generic error is issued

/users/forgot

access: [WRITE]

This method manages the "forgot password" procedure.

Example 1 (json)

Request

https://joturl.com/a/i1/users/forgot?email=my.email%40addess.is.here&code=12345&captcha=9d6a90a8

Query parameters

  email = my.email@addess.is.here
   code = 12345
captcha = 9d6a90a8

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "message": "An e-mail with your login credentials has been sent to 'my.email@addess.is.here'."
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/forgot?email=my.email%40addess.is.here&code=12345&captcha=9d6a90a8&format=xml

Query parameters

  email = my.email@addess.is.here
   code = 12345
captcha = 9d6a90a8
 format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <message>An e-mail with your login credentials has been sent to 'my.email@addess.is.here'.</message>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/forgot?email=my.email%40addess.is.here&code=12345&captcha=9d6a90a8&format=txt

Query parameters

  email = my.email@addess.is.here
   code = 12345
captcha = 9d6a90a8
 format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_message=An e-mail with your login credentials has been sent to 'my.email@addess.is.here'.

Example 4 (plain)

Request

https://joturl.com/a/i1/users/forgot?email=my.email%40addess.is.here&code=12345&captcha=9d6a90a8&format=plain

Query parameters

  email = my.email@addess.is.here
   code = 12345
captcha = 9d6a90a8
 format = plain

Response

An e-mail with your login credentials has been sent to 'my.email@addess.is.here'.
Required parameters
parameterdescriptionmax length
captchaSTRINGID of the captcha, see i1/users/captcha for details
codeSTRINGthe code present in the captcha image and that the user has transcribed
emailSTRINGemail address of the user that wants to start the "forgot password" procedure255

/users/info

access: [READ]

This method returns info about the logged user.

Example 1 (json)

Request

https://joturl.com/a/i1/users/info

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "actually_subuser": 0,
    "company": "JotUrl",
    "default_domain_id": "9ef5d4939db9a935e7102a15aaa221af",
    "email": "my.email@address.to",
    "full_name": "Jon Smith",
    "gender": "m",
    "inactivity_timeout": 0,
    "is_readonly": 0,
    "location": "IT",
    "login": "my.email@address.to",
    "need_to_change_password": 0,
    "news_offers_consent": 0,
    "phone_number": "+1234567891011",
    "registration_time": "2018-06-25 23:18:21",
    "short_name": "JS",
    "spider_email": "",
    "spider_email_frequency": 1,
    "stats_permanency_days": 365,
    "subuser": 0
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/info?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <actually_subuser>0</actually_subuser>  
    <company>JotUrl</company>  
    <default_domain_id>9ef5d4939db9a935e7102a15aaa221af</default_domain_id>  
    <email>my.email@address.to</email>  
    <full_name>Jon Smith</full_name>  
    <gender>m</gender>  
    <inactivity_timeout>0</inactivity_timeout>  
    <is_readonly>0</is_readonly>  
    <location>IT</location>  
    <login>my.email@address.to</login>  
    <need_to_change_password>0</need_to_change_password>  
    <news_offers_consent>0</news_offers_consent>  
    <phone_number>+1234567891011</phone_number>  
    <registration_time>2018-06-25 23:18:21</registration_time>  
    <short_name>JS</short_name>  
    <spider_email></spider_email>  
    <spider_email_frequency>1</spider_email_frequency>  
    <stats_permanency_days>365</stats_permanency_days>  
    <subuser>0</subuser>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/info?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_actually_subuser=0
result_company=JotUrl
result_default_domain_id=9ef5d4939db9a935e7102a15aaa221af
result_email=my.email@address.to
result_full_name=Jon Smith
result_gender=m
result_inactivity_timeout=0
result_is_readonly=0
result_location=IT
result_login=my.email@address.to
result_need_to_change_password=0
result_news_offers_consent=0
result_phone_number=+1234567891011
result_registration_time=2018-06-25 23:18:21
result_short_name=JS
result_spider_email=
result_spider_email_frequency=1
result_stats_permanency_days=365
result_subuser=0

Example 4 (plain)

Request

https://joturl.com/a/i1/users/info?format=plain

Query parameters

format = plain

Response

0
JotUrl
9ef5d4939db9a935e7102a15aaa221af
my.email@address.to
Jon Smith
m
0
0
IT
my.email@address.to
0
0
+1234567891011
2018-06-25 23:18:21
JS

1
365
0
Optional parameters
parameterdescription
fieldsARRAYcomma separated list of fields to return, available fields: actually_subuser, company, default_domain_id, email, full_name, gender, inactivity_timeout, is_readonly, location, login, need_to_change_password, news_offers_consent, phone_number, registration_time, short_name, spider_email, spider_email_frequency, stats_permanency_days, subuser
Return values
parameterdescription
datainformation on the user/subuser

/users/jotbars

/users/jotbars/edit

access: [WRITE]

Set a jotbar option for a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/users/jotbars/edit?user_id=9bdaf550361da3f83e208dfb6983d07a&logo=https%3A%2F%2Fjoturl.com%2Flogo.svg&logo_url=https%3A%2F%2Fjoturl.com%2F&template=right&template_size=big&languages=en,it&default_language=&default_language=en&info=%7B%22en%22%3A%7B%22page_title%22%3A%22English+page+title%22,%22description_title%22%3Anull,%22description%22%3A%22%3Cp%3E%5BEN%5D+HTML+description%3C%5C%2Fp%3E%22,%22questions_title%22%3Anull,%22questions%22%3A%22%3Cp%3E%5BEN%5D+HTML+questions%3C%5C%2Fp%3E%22%7D,%22it%22%3A%7B%22page_title%22%3A%22Titolo+pagina+in+italiano%22,%22description_title%22%3Anull,%22description%22%3A%22%3Cp%3E%5BIT%5D+HTML+description%3C%5C%2Fp%3E%22,%22questions_title%22%3Anull,%22questions%22%3A%22%3Cp%3E%5BIT%5D+HTML+questions%3C%5C%2Fp%3E%22%7D%7D

Query parameters

         user_id = 9bdaf550361da3f83e208dfb6983d07a
            logo = https://joturl.com/logo.svg
        logo_url = https://joturl.com/
        template = right
   template_size = big
       languages = en,it
default_language = en
            info = {"en":{"page_title":"English page title","description_title":null,"description":"<p>[EN] HTML description<\/p>","questions_title":null,"questions":"<p>[EN] HTML questions<\/p>"},"it":{"page_title":"Titolo pagina in italiano","description_title":null,"description":"<p>[IT] HTML description<\/p>","questions_title":null,"questions":"<p>[IT] HTML questions<\/p>"}}

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "updated": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/jotbars/edit?user_id=9bdaf550361da3f83e208dfb6983d07a&logo=https%3A%2F%2Fjoturl.com%2Flogo.svg&logo_url=https%3A%2F%2Fjoturl.com%2F&template=right&template_size=big&languages=en,it&default_language=&default_language=en&info=%7B%22en%22%3A%7B%22page_title%22%3A%22English+page+title%22,%22description_title%22%3Anull,%22description%22%3A%22%3Cp%3E%5BEN%5D+HTML+description%3C%5C%2Fp%3E%22,%22questions_title%22%3Anull,%22questions%22%3A%22%3Cp%3E%5BEN%5D+HTML+questions%3C%5C%2Fp%3E%22%7D,%22it%22%3A%7B%22page_title%22%3A%22Titolo+pagina+in+italiano%22,%22description_title%22%3Anull,%22description%22%3A%22%3Cp%3E%5BIT%5D+HTML+description%3C%5C%2Fp%3E%22,%22questions_title%22%3Anull,%22questions%22%3A%22%3Cp%3E%5BIT%5D+HTML+questions%3C%5C%2Fp%3E%22%7D%7D&format=xml

Query parameters

         user_id = 9bdaf550361da3f83e208dfb6983d07a
            logo = https://joturl.com/logo.svg
        logo_url = https://joturl.com/
        template = right
   template_size = big
       languages = en,it
default_language = en
            info = {"en":{"page_title":"English page title","description_title":null,"description":"<p>[EN] HTML description<\/p>","questions_title":null,"questions":"<p>[EN] HTML questions<\/p>"},"it":{"page_title":"Titolo pagina in italiano","description_title":null,"description":"<p>[IT] HTML description<\/p>","questions_title":null,"questions":"<p>[IT] HTML questions<\/p>"}}
          format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <updated>1</updated>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/jotbars/edit?user_id=9bdaf550361da3f83e208dfb6983d07a&logo=https%3A%2F%2Fjoturl.com%2Flogo.svg&logo_url=https%3A%2F%2Fjoturl.com%2F&template=right&template_size=big&languages=en,it&default_language=&default_language=en&info=%7B%22en%22%3A%7B%22page_title%22%3A%22English+page+title%22,%22description_title%22%3Anull,%22description%22%3A%22%3Cp%3E%5BEN%5D+HTML+description%3C%5C%2Fp%3E%22,%22questions_title%22%3Anull,%22questions%22%3A%22%3Cp%3E%5BEN%5D+HTML+questions%3C%5C%2Fp%3E%22%7D,%22it%22%3A%7B%22page_title%22%3A%22Titolo+pagina+in+italiano%22,%22description_title%22%3Anull,%22description%22%3A%22%3Cp%3E%5BIT%5D+HTML+description%3C%5C%2Fp%3E%22,%22questions_title%22%3Anull,%22questions%22%3A%22%3Cp%3E%5BIT%5D+HTML+questions%3C%5C%2Fp%3E%22%7D%7D&format=txt

Query parameters

         user_id = 9bdaf550361da3f83e208dfb6983d07a
            logo = https://joturl.com/logo.svg
        logo_url = https://joturl.com/
        template = right
   template_size = big
       languages = en,it
default_language = en
            info = {"en":{"page_title":"English page title","description_title":null,"description":"<p>[EN] HTML description<\/p>","questions_title":null,"questions":"<p>[EN] HTML questions<\/p>"},"it":{"page_title":"Titolo pagina in italiano","description_title":null,"description":"<p>[IT] HTML description<\/p>","questions_title":null,"questions":"<p>[IT] HTML questions<\/p>"}}
          format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_updated=1

Example 4 (plain)

Request

https://joturl.com/a/i1/users/jotbars/edit?user_id=9bdaf550361da3f83e208dfb6983d07a&logo=https%3A%2F%2Fjoturl.com%2Flogo.svg&logo_url=https%3A%2F%2Fjoturl.com%2F&template=right&template_size=big&languages=en,it&default_language=&default_language=en&info=%7B%22en%22%3A%7B%22page_title%22%3A%22English+page+title%22,%22description_title%22%3Anull,%22description%22%3A%22%3Cp%3E%5BEN%5D+HTML+description%3C%5C%2Fp%3E%22,%22questions_title%22%3Anull,%22questions%22%3A%22%3Cp%3E%5BEN%5D+HTML+questions%3C%5C%2Fp%3E%22%7D,%22it%22%3A%7B%22page_title%22%3A%22Titolo+pagina+in+italiano%22,%22description_title%22%3Anull,%22description%22%3A%22%3Cp%3E%5BIT%5D+HTML+description%3C%5C%2Fp%3E%22,%22questions_title%22%3Anull,%22questions%22%3A%22%3Cp%3E%5BIT%5D+HTML+questions%3C%5C%2Fp%3E%22%7D%7D&format=plain

Query parameters

         user_id = 9bdaf550361da3f83e208dfb6983d07a
            logo = https://joturl.com/logo.svg
        logo_url = https://joturl.com/
        template = right
   template_size = big
       languages = en,it
default_language = en
            info = {"en":{"page_title":"English page title","description_title":null,"description":"<p>[EN] HTML description<\/p>","questions_title":null,"questions":"<p>[EN] HTML questions<\/p>"},"it":{"page_title":"Titolo pagina in italiano","description_title":null,"description":"<p>[IT] HTML description<\/p>","questions_title":null,"questions":"<p>[IT] HTML questions<\/p>"}}
          format = plain

Response

1
Optional parameters
parameterdescription
default_languageSTRINGset the account-level default language, see i1/users/languages/set for details
infoJSONJSON containing page_title, description_title, description, questions_title, questions for each enabled language, see i1/users/languages/set for details
logoSTRINGit can be: the URL of the logo to be shown; empty or null to disable it
logo_urlSTRINGwhen logo has an URL, this is the URL to which the user will be redirect when he/she clicks on the logo
show_feedbackSTRING1 to show feedback, 0 to do not show it
templateSTRINGposition of the jotbar, empty or null to disable the jotbar feature, for available positions see i1/jotbars/property
template_sizeSTRINGdimension of the jotbar, empty or null to disable the jotbar feature, for available dimensions see i1/jotbars/property
Return values
parameterdescription
updated1 on success, 0 otherwise

/users/jotbars/info

access: [READ]

Get account-level settings for the jotbar.

Example 1 (json)

Request

https://joturl.com/a/i1/users/jotbars/info?user_id=31d73acf8e35a9b6b26edce7fe40c108

Query parameters

user_id = 31d73acf8e35a9b6b26edce7fe40c108

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "logo": "https:\/\/joturl.com\/logo.svg",
    "logo_url": "https:\/\/joturl.com\/",
    "template": "right",
    "template_size": "big",
    "show_feedback": null,
    "default_language": "en",
    "info": {
      "en": {
        "page_title": "English page title",
        "description_title": null,
        "description": "<p>[EN] HTML description<\/p>",
        "questions_title": null,
        "questions": "<p>[EN] HTML questions<\/p>"
      },
      "it": {
        "page_title": "Titolo pagina in italiano",
        "description_title": null,
        "description": "<p>[IT] HTML description<\/p>",
        "questions_title": null,
        "questions": "<p>[IT] HTML questions<\/p>"
      }
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/jotbars/info?user_id=31d73acf8e35a9b6b26edce7fe40c108&format=xml

Query parameters

user_id = 31d73acf8e35a9b6b26edce7fe40c108
 format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <logo>https://joturl.com/logo.svg</logo>  
    <logo_url>https://joturl.com/</logo_url>  
    <template>right</template>  
    <template_size>big</template_size>  
    <show_feedback></show_feedback>  
    <default_language>en</default_language>  
    <info>
      <en>
        <page_title>English page title</page_title>  
        <description_title></description_title>  
        <description><[CDATA[&lt;p&gt;[EN] HTML description&lt;/p&gt;]]></description>  
        <questions_title></questions_title>  
        <questions><[CDATA[&lt;p&gt;[EN] HTML questions&lt;/p&gt;]]></questions>  
      </en>  
      <it>
        <page_title>Titolo pagina in italiano</page_title>  
        <description_title></description_title>  
        <description><[CDATA[&lt;p&gt;[IT] HTML description&lt;/p&gt;]]></description>  
        <questions_title></questions_title>  
        <questions><[CDATA[&lt;p&gt;[IT] HTML questions&lt;/p&gt;]]></questions>  
      </it>  
    </info>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/jotbars/info?user_id=31d73acf8e35a9b6b26edce7fe40c108&format=txt

Query parameters

user_id = 31d73acf8e35a9b6b26edce7fe40c108
 format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_logo=https://joturl.com/logo.svg
result_logo_url=https://joturl.com/
result_template=right
result_template_size=big
result_show_feedback=
result_default_language=en
result_info_en_page_title=English page title
result_info_en_description_title=
result_info_en_description=&lt;p&gt;[EN] HTML description&lt;/p&gt;
result_info_en_questions_title=
result_info_en_questions=&lt;p&gt;[EN] HTML questions&lt;/p&gt;
result_info_it_page_title=Titolo pagina in italiano
result_info_it_description_title=
result_info_it_description=&lt;p&gt;[IT] HTML description&lt;/p&gt;
result_info_it_questions_title=
result_info_it_questions=&lt;p&gt;[IT] HTML questions&lt;/p&gt;

Example 4 (plain)

Request

https://joturl.com/a/i1/users/jotbars/info?user_id=31d73acf8e35a9b6b26edce7fe40c108&format=plain

Query parameters

user_id = 31d73acf8e35a9b6b26edce7fe40c108
 format = plain

Response

https://joturl.com/logo.svg
https://joturl.com/
right
big

en
English page title

&lt;p&gt;[EN] HTML description&lt;/p&gt;

&lt;p&gt;[EN] HTML questions&lt;/p&gt;
Titolo pagina in italiano

&lt;p&gt;[IT] HTML description&lt;/p&gt;

&lt;p&gt;[IT] HTML questions&lt;/p&gt;
Return values
parameterdescription
infofor each enabled language, it contains page_title, description_title, description, questions_title, questions, see the following notes for details
user_default_languageaccount-level default language, see i1/users/languages/list for details
user_logothe URL of the logo to be shown or empty or null to disable it
user_logo_urlwhen user_logo has an URL, this is the URL to which the user will be redirect when clicks on the logo
user_show_feedback1 to show feedback, 0 to do not show it
user_templateposition of the jotbar, empty or null to disable the jotbar feature, for available positions see i1/jotbars/property
user_template_sizedimension of the jotbar, empty or null to disable the jotbar feature, for available dimensions see i1/jotbars/property

/users/languages

/users/languages/list

access: [READ]

This method returns a list of available languages for specific options (e.g., Masking, jotBar) of a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/users/languages/list

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "languages": [
      {
        "name": "en",
        "label": "English"
      },
      {
        "name": "it",
        "label": "Italiano"
      },
      {
        "name": "de",
        "label": "Deutsch"
      },
      {
        "name": "fr",
        "label": "Française"
      },
      {
        "name": "es",
        "label": "Español"
      },
      {
        "name": "jp",
        "label": "\u65e5\u672c"
      }
    ],
    "selected": [
      "en",
      "it"
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/languages/list?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <languages>
      <i0>
        <name>en</name>  
        <label>English</label>  
      </i0>  
      <i1>
        <name>it</name>  
        <label>Italiano</label>  
      </i1>  
      <i2>
        <name>de</name>  
        <label>Deutsch</label>  
      </i2>  
      <i3>
        <name>fr</name>  
        <label><[CDATA[Fran&ccedil;aise]]></label>  
      </i3>  
      <i4>
        <name>es</name>  
        <label><[CDATA[Espa&ntilde;ol]]></label>  
      </i4>  
      <i5>
        <name>jp</name>  
        <label>日本</label>  
      </i5>  
    </languages>  
    <selected>
      <i0>en</i0>  
      <i1>it</i1>  
    </selected>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/languages/list?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_languages_0_name=en
result_languages_0_label=English
result_languages_1_name=it
result_languages_1_label=Italiano
result_languages_2_name=de
result_languages_2_label=Deutsch
result_languages_3_name=fr
result_languages_3_label=Fran&ccedil;aise
result_languages_4_name=es
result_languages_4_label=Espa&ntilde;ol
result_languages_5_name=jp
result_languages_5_label=日本
result_selected_0=en
result_selected_1=it

Example 4 (plain)

Request

https://joturl.com/a/i1/users/languages/list?format=plain

Query parameters

format = plain

Response

en
English
it
Italiano
de
Deutsch
fr
Fran&ccedil;aise
es
Espa&ntilde;ol
jp
日本
en
it
Return values
parameterdescription
languagesarray of available languages (name,label)
selectedarray of enabled languages (name)

/users/languages/set

access: [WRITE]

This method enables a list of languages for the current user.

Example 1 (json)

Request

https://joturl.com/a/i1/users/languages/set?langs=en,it

Query parameters

langs = en,it

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "updated": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/languages/set?langs=en,it&format=xml

Query parameters

 langs = en,it
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <updated>1</updated>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/languages/set?langs=en,it&format=txt

Query parameters

 langs = en,it
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_updated=1

Example 4 (plain)

Request

https://joturl.com/a/i1/users/languages/set?langs=en,it&format=plain

Query parameters

 langs = en,it
format = plain

Response

1
Required parameters
parameterdescription
langsARRAYcomma-separated list of languages to enable, each language is identified by its name, see i1/users/languages/list for details
Return values
parameterdescription
updated1 in case of success, 0 in case of failure or if there was no change in the list of languages

/users/login

access: [WRITE]

This method allows a user to login into the private area via credentials or through an external provider.

Example 1 (json)

Request

https://joturl.com/a/i1/users/login?username=username%40domain.ext&password=ce55a4bf

Query parameters

username = username@domain.ext
password = ce55a4bf

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "session_id": "1ef4f68a244d92a7f62d2b18373a413d"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/login?username=username%40domain.ext&password=ce55a4bf&format=xml

Query parameters

username = username@domain.ext
password = ce55a4bf
  format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <session_id>1ef4f68a244d92a7f62d2b18373a413d</session_id>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/login?username=username%40domain.ext&password=ce55a4bf&format=txt

Query parameters

username = username@domain.ext
password = ce55a4bf
  format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_session_id=1ef4f68a244d92a7f62d2b18373a413d

Example 4 (plain)

Request

https://joturl.com/a/i1/users/login?username=username%40domain.ext&password=ce55a4bf&format=plain

Query parameters

username = username@domain.ext
password = ce55a4bf
  format = plain

Response

1ef4f68a244d92a7f62d2b18373a413d
Optional parameters
parameterdescriptionmax length
captchaSTRINGused when signup = 1, see i1/users/signup for details
codeSTRINGused when signup = 1, see i1/users/signup for details
news_offers_consentBOOLEANused when signup = 1, see i1/users/signup for details
passwordSTRINGpassword to use to log in100
providerSTRINGalternative login provider, available providers: microsoftgraph, amazon, google, facebook, twitter, windowslive, linkedin100
redirectURLredirect URL to be used after logged in, only used if parameter provider is passed4000
signupBOOLEANused when provider is passed, signup = 1 forces the signup from an alternative login when the user is not already registered, signup = 0 has no effect
tfa_codeSTRING2-factor authentication code if enabled, see i1/users/2fa/info for details
tokenSTRINGused when signup = 1, see i1/users/signup for details
tos_pp_consentBOOLEANused when signup = 1, see i1/users/signup for details
usernameSTRINGuser name to use to log in255
Return values
parameterdescription
datetimeserver date and time, to be used to synchronize calls
device_ida unique ID that identifies the device from which the login is being made
session_idID of the login session

/users/logout

access: [WRITE]

This method executes a logout.

Example 1 (json)

Request

https://joturl.com/a/i1/users/logout

Response

{
  "status": {
    "code": 200,
    "text": "OK"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/logout?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
  </status>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/logout?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK

Example 4 (plain)

Request

https://joturl.com/a/i1/users/logout?format=plain

Query parameters

format = plain

Response

200
OK
Optional parameters
parameterdescription
logout_allBOOLEANset to 1 if you want to disconnect from all accounts on all devices
Return values
parameterdescription
old_session_idID of the login session that was just destroyed
redir_urlURL to redirect the user to

/users/notifications

/users/notifications/count

access: [READ]

This method returns the number of new notifications for the user.

Example 1 (json)

Request

https://joturl.com/a/i1/users/notifications/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 6
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/notifications/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>6</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/notifications/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=6

Example 4 (plain)

Request

https://joturl.com/a/i1/users/notifications/count?format=plain

Query parameters

format = plain

Response

6
Return values
parameterdescription
countnumber of available notifications

/users/notifications/list

access: [READ]

This method returns a list of notifications for the user.

Example 1 (json)

Request

https://joturl.com/a/i1/users/notifications/list

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "2020-10-24": [
      {
        "notification_id": "e951fb209133cc9b9369653737074aea",
        "datetime": "2020-10-24T18:20:39+02:00",
        "read": 0,
        "type": 0,
        "type_description": "deleted",
        "short_url": "jo.my\/joturl",
        "who": "User Name (user@email)",
        "long_url": {
          "old": "",
          "new": ""
        }
      },
      {
        "notification_id": "70ebd82d966bfb08983744dc0cfd11d4",
        "datetime": "2020-10-24T18:16:47+02:00",
        "read": 1,
        "type": 0,
        "type_description": "deleted",
        "short_url": "jo.my\/joturl",
        "who": "you",
        "long_url": {
          "old": "",
          "new": ""
        }
      }
    ],
    "2020-10-20": [
      {
        "notification_id": "78a794ef85268917f51ac3c15f8c78d3",
        "datetime": "2020-10-20T16:37:32+02:00",
        "read": 1,
        "type": 1,
        "type_description": "long url changed",
        "short_url": "jo.my\/joturl",
        "who": "you",
        "long_url": {
          "old": "http:\/\/www.joturl.com\/",
          "new": "https:\/\/joturl.com\/"
        }
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/notifications/list?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <2020-10-24>
      <i0>
        <notification_id>e951fb209133cc9b9369653737074aea</notification_id>  
        <datetime>2020-10-24T18:20:39+02:00</datetime>  
        <read>0</read>  
        <type>0</type>  
        <type_description>deleted</type_description>  
        <short_url>jo.my/joturl</short_url>  
        <who>User Name (user@email)</who>  
        <long_url>
          <old></old>  
          <new></new>  
        </long_url>  
      </i0>  
      <i1>
        <notification_id>70ebd82d966bfb08983744dc0cfd11d4</notification_id>  
        <datetime>2020-10-24T18:16:47+02:00</datetime>  
        <read>1</read>  
        <type>0</type>  
        <type_description>deleted</type_description>  
        <short_url>jo.my/joturl</short_url>  
        <who>you</who>  
        <long_url>
          <old></old>  
          <new></new>  
        </long_url>  
      </i1>  
    </2020-10-24>  
    <2020-10-20>
      <i0>
        <notification_id>78a794ef85268917f51ac3c15f8c78d3</notification_id>  
        <datetime>2020-10-20T16:37:32+02:00</datetime>  
        <read>1</read>  
        <type>1</type>  
        <type_description>long url changed</type_description>  
        <short_url>jo.my/joturl</short_url>  
        <who>you</who>  
        <long_url>
          <old>http://www.joturl.com/</old>  
          <new>https://joturl.com/</new>  
        </long_url>  
      </i0>  
    </2020-10-20>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/notifications/list?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_2020-10-24_0_notification_id=e951fb209133cc9b9369653737074aea
result_2020-10-24_0_datetime=2020-10-24T18:20:39+02:00
result_2020-10-24_0_read=0
result_2020-10-24_0_type=0
result_2020-10-24_0_type_description=deleted
result_2020-10-24_0_short_url=jo.my/joturl
result_2020-10-24_0_who=User Name (user@email)
result_2020-10-24_0_long_url_old=
result_2020-10-24_0_long_url_new=
result_2020-10-24_1_notification_id=70ebd82d966bfb08983744dc0cfd11d4
result_2020-10-24_1_datetime=2020-10-24T18:16:47+02:00
result_2020-10-24_1_read=1
result_2020-10-24_1_type=0
result_2020-10-24_1_type_description=deleted
result_2020-10-24_1_short_url=jo.my/joturl
result_2020-10-24_1_who=you
result_2020-10-24_1_long_url_old=
result_2020-10-24_1_long_url_new=
result_2020-10-20_0_notification_id=78a794ef85268917f51ac3c15f8c78d3
result_2020-10-20_0_datetime=2020-10-20T16:37:32+02:00
result_2020-10-20_0_read=1
result_2020-10-20_0_type=1
result_2020-10-20_0_type_description=long url changed
result_2020-10-20_0_short_url=jo.my/joturl
result_2020-10-20_0_who=you
result_2020-10-20_0_long_url_old=http://www.joturl.com/
result_2020-10-20_0_long_url_new=https://joturl.com/

Example 4 (plain)

Request

https://joturl.com/a/i1/users/notifications/list?format=plain

Query parameters

format = plain

Response

jo.my/joturl
jo.my/joturl
jo.my/joturl
Optional parameters
parameterdescription
lengthINTEGERextracts this number of notifications (maxmimum allowed: 100)
startINTEGERstarts to extract notifications from this position
Return values
parameterdescription
dataarray containing information on notifications

/users/renew

access: [WRITE]

This method executes renew operations.

Example 1 (json)

Request

https://joturl.com/a/i1/users/renew?info=6c23f5f889de4444e6daafad6acfa5c2

Query parameters

info = 6c23f5f889de4444e6daafad6acfa5c2

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "ok": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/renew?info=6c23f5f889de4444e6daafad6acfa5c2&format=xml

Query parameters

  info = 6c23f5f889de4444e6daafad6acfa5c2
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <ok>1</ok>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/renew?info=6c23f5f889de4444e6daafad6acfa5c2&format=txt

Query parameters

  info = 6c23f5f889de4444e6daafad6acfa5c2
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_ok=1

Example 4 (plain)

Request

https://joturl.com/a/i1/users/renew?info=6c23f5f889de4444e6daafad6acfa5c2&format=plain

Query parameters

  info = 6c23f5f889de4444e6daafad6acfa5c2
format = plain

Response

1
Required parameters
parameterdescription
infoSTRINGtoken sent to the user email

/users/reports

/users/reports/get

access: [READ]

This method get the configuration for reports.

Example 1 (json)

Request

https://joturl.com/a/i1/users/reports/get

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "enabled": 1,
    "position": "top_left",
    "id": "3b5211420e215c59cde898f8d2d6bfad",
    "metadata": {
      "name": "my logo",
      "creation": "2025-06-27 16:53:15",
      "width": 400,
      "height": 300,
      "size": 32442,
      "url": "https:\/\/cdn.endpoint\/path\/to\/resource"
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/reports/get?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <enabled>1</enabled>  
    <position>top_left</position>  
    <id>3b5211420e215c59cde898f8d2d6bfad</id>  
    <metadata>
      <name>my logo</name>  
      <creation>2025-06-27 16:53:15</creation>  
      <width>400</width>  
      <height>300</height>  
      <size>32442</size>  
      <url>https://cdn.endpoint/path/to/resource</url>  
    </metadata>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/reports/get?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_enabled=1
result_position=top_left
result_id=3b5211420e215c59cde898f8d2d6bfad
result_metadata_name=my logo
result_metadata_creation=2025-06-27 16:53:15
result_metadata_width=400
result_metadata_height=300
result_metadata_size=32442
result_metadata_url=https://cdn.endpoint/path/to/resource

Example 4 (plain)

Request

https://joturl.com/a/i1/users/reports/get?format=plain

Query parameters

format = plain

Response

1
top_left
3b5211420e215c59cde898f8d2d6bfad
my logo
2025-06-27 16:53:15
400
300
32442
https://cdn.endpoint/path/to/resource
Return values
parameterdescription
enabled1 when custom logo in reports is enabled, 0 otherwise
idID of the CDN resource used as custom logo in reports if enabled = 1, empty or null if enabled = 0
metadataarray containing information on the CDN resource
positionposition of the custom logo if enabled = 1, empty or null if enabled = 0

/users/reports/property

access: [READ]

Returns allowed position for the custom logo in reports.

Example 1 (json)

Request

https://joturl.com/a/i1/users/reports/property

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "positions": [
      "top_left",
      "top_center",
      "top_right"
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/reports/property?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <positions>
      <i0>top_left</i0>  
      <i1>top_center</i1>  
      <i2>top_right</i2>  
    </positions>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/reports/property?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_positions_0=top_left
result_positions_1=top_center
result_positions_2=top_right

Example 4 (plain)

Request

https://joturl.com/a/i1/users/reports/property?format=plain

Query parameters

format = plain

Response

top_left
top_center
top_right
Return values
parameterdescription
positionsavailable position for the custom logo in reports

/users/reports/set

access: [WRITE]

This method sets the configuration for reports.

Example 1 (json)

Request

https://joturl.com/a/i1/users/reports/set?enabled=0

Query parameters

enabled = 0

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/reports/set?enabled=0&format=xml

Query parameters

enabled = 0
 format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/reports/set?enabled=0&format=txt

Query parameters

enabled = 0
 format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/users/reports/set?enabled=0&format=plain

Query parameters

enabled = 0
 format = plain

Response

1

Example 5 (json)

Request

https://joturl.com/a/i1/users/reports/set?enabled=1&id=f375dfc030489f30cf55fd079b7150d2&position=top_left

Query parameters

 enabled = 1
      id = f375dfc030489f30cf55fd079b7150d2
position = top_left

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "updated": 1
  }
}

Example 6 (xml)

Request

https://joturl.com/a/i1/users/reports/set?enabled=1&id=f375dfc030489f30cf55fd079b7150d2&position=top_left&format=xml

Query parameters

 enabled = 1
      id = f375dfc030489f30cf55fd079b7150d2
position = top_left
  format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <updated>1</updated>  
  </result>  
</response>

Example 7 (txt)

Request

https://joturl.com/a/i1/users/reports/set?enabled=1&id=f375dfc030489f30cf55fd079b7150d2&position=top_left&format=txt

Query parameters

 enabled = 1
      id = f375dfc030489f30cf55fd079b7150d2
position = top_left
  format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_updated=1

Example 8 (plain)

Request

https://joturl.com/a/i1/users/reports/set?enabled=1&id=f375dfc030489f30cf55fd079b7150d2&position=top_left&format=plain

Query parameters

 enabled = 1
      id = f375dfc030489f30cf55fd079b7150d2
position = top_left
  format = plain

Response

1
Required parameters
parameterdescription
enabledBOOLEAN1 to enable the custom logo in reports, 0 to disable it
Optional parameters
parameterdescription
idIDID of the CDN resource to use as logo
positionSTRINGposition of the logo, see i1/users/reports/property for available position
Return values
parameterdescription
deleted[OPTIONAL] 1 on success, 0 otherwise, only returned when enabled = 0
updated[OPTIONAL] 1 on success, 0 otherwise, only returned when enabled = 1

/users/security

/users/security/info

access: [READ]

This method returns advanced security settings for the logged user. Ony available to admin users.

Example 1 (json)

Request

https://joturl.com/a/i1/users/security/info

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "inactivity_timeout": 15,
    "force_change_password_interval": 0,
    "do_not_allow_old_passwords": 0,
    "warning_on_anomalous_logins": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/security/info?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <inactivity_timeout>15</inactivity_timeout>  
    <force_change_password_interval>0</force_change_password_interval>  
    <do_not_allow_old_passwords>0</do_not_allow_old_passwords>  
    <warning_on_anomalous_logins>1</warning_on_anomalous_logins>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/security/info?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_inactivity_timeout=15
result_force_change_password_interval=0
result_do_not_allow_old_passwords=0
result_warning_on_anomalous_logins=1

Example 4 (plain)

Request

https://joturl.com/a/i1/users/security/info?format=plain

Query parameters

format = plain

Response

15
0
0
1
Return values
parameterdescription
do_not_allow_old_passwordsnumber of previous passwords that the user cannot use when changing password; allowed values from 2 to 10 inclusive, 0 means disabled
force_change_password_intervalthe time in months after which the user must change password; allowed values from 2 to 60 inclusive, 0 means disabled
inactivity_timeoutthe time in minutes after which the user is disconnected in the absence of activity; allowed values from 15 to 43200 inclusive, 0 means disabled
warning_on_anomalous_logins1 to send an email in case of access from previously unused devices/IPs, 0 otherwise

/users/security/set

access: [WRITE]

This method sets advanced security settings for the logged user. Ony available to admin users.

Example 1 (json)

Request

https://joturl.com/a/i1/users/security/set?inactivity_timeout=15&force_change_password=0&do_not_allow_old_passwords=0&warning_on_anomalous_logins=1

Query parameters

         inactivity_timeout = 15
      force_change_password = 0
 do_not_allow_old_passwords = 0
warning_on_anomalous_logins = 1

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "inactivity_timeout": 15,
    "force_change_password": 0,
    "do_not_allow_old_passwords": 0,
    "warning_on_anomalous_logins": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/security/set?inactivity_timeout=15&force_change_password=0&do_not_allow_old_passwords=0&warning_on_anomalous_logins=1&format=xml

Query parameters

         inactivity_timeout = 15
      force_change_password = 0
 do_not_allow_old_passwords = 0
warning_on_anomalous_logins = 1
                     format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <inactivity_timeout>15</inactivity_timeout>  
    <force_change_password>0</force_change_password>  
    <do_not_allow_old_passwords>0</do_not_allow_old_passwords>  
    <warning_on_anomalous_logins>1</warning_on_anomalous_logins>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/security/set?inactivity_timeout=15&force_change_password=0&do_not_allow_old_passwords=0&warning_on_anomalous_logins=1&format=txt

Query parameters

         inactivity_timeout = 15
      force_change_password = 0
 do_not_allow_old_passwords = 0
warning_on_anomalous_logins = 1
                     format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_inactivity_timeout=15
result_force_change_password=0
result_do_not_allow_old_passwords=0
result_warning_on_anomalous_logins=1

Example 4 (plain)

Request

https://joturl.com/a/i1/users/security/set?inactivity_timeout=15&force_change_password=0&do_not_allow_old_passwords=0&warning_on_anomalous_logins=1&format=plain

Query parameters

         inactivity_timeout = 15
      force_change_password = 0
 do_not_allow_old_passwords = 0
warning_on_anomalous_logins = 1
                     format = plain

Response

15
0
0
1
Optional parameters
parameterdescription
do_not_allow_old_passwordsINTEGERnumber of previous passwords that the user cannot use when changing password; allowed values from 2 to 10 inclusive, 0 means disabled
force_change_passwordINTEGERthe time in months after which the user must change password; allowed values from 2 to 60 inclusive, 0 means disabled
inactivity_timeoutINTEGERthe time in minutes after which the user is disconnected in the absence of activity; allowed values from 15 to 43200 inclusive, 0 means disabled
warning_on_anomalous_loginsSTRING1 to send an email in case of access from previously unused devices/IPs, 0 otherwise
Return values
parameterdescription
updated1 on success, 0 otherwise

/users/set

access: [WRITE]

This method set info about the logged user.

Example 1 (json)

Request

https://joturl.com/a/i1/users/set?old_password=e662eba33353edd85625514193b79a5a&new_password=3a6d89ea346977190e7c74e2a983ec52&confirm_password=3a6d89ea346977190e7c74e2a983ec52

Query parameters

    old_password = e662eba33353edd85625514193b79a5a
    new_password = 3a6d89ea346977190e7c74e2a983ec52
confirm_password = 3a6d89ea346977190e7c74e2a983ec52

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "updated": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/set?old_password=e662eba33353edd85625514193b79a5a&new_password=3a6d89ea346977190e7c74e2a983ec52&confirm_password=3a6d89ea346977190e7c74e2a983ec52&format=xml

Query parameters

    old_password = e662eba33353edd85625514193b79a5a
    new_password = 3a6d89ea346977190e7c74e2a983ec52
confirm_password = 3a6d89ea346977190e7c74e2a983ec52
          format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <updated>1</updated>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/set?old_password=e662eba33353edd85625514193b79a5a&new_password=3a6d89ea346977190e7c74e2a983ec52&confirm_password=3a6d89ea346977190e7c74e2a983ec52&format=txt

Query parameters

    old_password = e662eba33353edd85625514193b79a5a
    new_password = 3a6d89ea346977190e7c74e2a983ec52
confirm_password = 3a6d89ea346977190e7c74e2a983ec52
          format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_updated=1

Example 4 (plain)

Request

https://joturl.com/a/i1/users/set?old_password=e662eba33353edd85625514193b79a5a&new_password=3a6d89ea346977190e7c74e2a983ec52&confirm_password=3a6d89ea346977190e7c74e2a983ec52&format=plain

Query parameters

    old_password = e662eba33353edd85625514193b79a5a
    new_password = 3a6d89ea346977190e7c74e2a983ec52
confirm_password = 3a6d89ea346977190e7c74e2a983ec52
          format = plain

Response

1
Optional parameters
parameterdescription
codeSTRINGsecurity code sent by email
companySTRINGcompany of the logged user
default_domain_idSTRINGthe default domain for the logged user, this setting will be used as the default setting for endpoints that do not require the domain ID
full_nameSTRINGfull name of the logged user
genderSTRINGgender of the logged user [m|f]
locationSTRINGISO 3166-1 alpha-2 code of the country of the logged user
news_offers_consentBOOLEAN1 if the logged user has authorized the offers by e-mail, 0 otherwise
phone_numberSTRINGphone number of the logged user
spider_emailSTRINGcomma separated list of emails to which content monitor will send security alerts, if not specified, login email will be used, maximum 10 email addresses are allowed
spider_email_frequencySTRINGhow often the content monitoring will send alerts, see i1/watchdogs/property for a list of available frequencies
Return values
parameterdescription
security_code_required[OPTIONAL] 1 if the security code is required, it is returned only when an email change is required
updated1 on success, 0 otherwise

/users/signup

access: [WRITE]

This method executes a signup.

Example 1 (json)

Request

https://joturl.com/a/i1/users/signup?name=Jon+Smith&email=my.smart%40email.address&password=869cf2d945480f85&confirm=869cf2d945480f85

Query parameters

    name = Jon Smith
   email = my.smart@email.address
password = 869cf2d945480f85
 confirm = 869cf2d945480f85

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "ok": 1,
    "need_confirm": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/signup?name=Jon+Smith&email=my.smart%40email.address&password=869cf2d945480f85&confirm=869cf2d945480f85&format=xml

Query parameters

    name = Jon Smith
   email = my.smart@email.address
password = 869cf2d945480f85
 confirm = 869cf2d945480f85
  format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <ok>1</ok>  
    <need_confirm>1</need_confirm>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/signup?name=Jon+Smith&email=my.smart%40email.address&password=869cf2d945480f85&confirm=869cf2d945480f85&format=txt

Query parameters

    name = Jon Smith
   email = my.smart@email.address
password = 869cf2d945480f85
 confirm = 869cf2d945480f85
  format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_ok=1
result_need_confirm=1

Example 4 (plain)

Request

https://joturl.com/a/i1/users/signup?name=Jon+Smith&email=my.smart%40email.address&password=869cf2d945480f85&confirm=869cf2d945480f85&format=plain

Query parameters

    name = Jon Smith
   email = my.smart@email.address
password = 869cf2d945480f85
 confirm = 869cf2d945480f85
  format = plain

Response

1
1
Required parameters
parameterdescription
tos_pp_consentBOOLEAN1 if the user has given consent for the terms of service and the privacy policy, 0 otherwise, it must be 1 to be able to sign up
Optional parameters
parameterdescriptionmax length
captchaSTRINGID of the captcha, see i1/users/captcha for details, optional to token
codeSTRINGthe code present in the captcha image and that the user has transcribed, optional to token
companySTRINGcompany of the user255
confirmSTRINGconfirmation for the password, must be the same as the password and retrieved from a different input field100
emailSTRINGemail of the user255
genderSTRINGgender of the user, possible values: [m, f], default: m1
locationSTRING2-digit code of the country (ISO Alpha-2) the user is based on (e.g., US), if not passed our engine tries to retrieve location from the browser50
nameSTRINGfull name of the user255
news_offers_consentBOOLEAN1 if the user has given consent for the news, 0 otherwise
passwordSTRINGpassword for the login100
tokenSTRINGGoogle reCAPTCHA token, optional to code and captcha
Return values
parameterdescription
need_confirm1 if the user must confirm his/hers email address by clicking on the email that our engine sent
ok1 on success, otherwise a generic error is issued

/users/stats

/users/stats/details

access: [READ]

This method returns detailed events on the last 30/60/90 days for the logged user.

Example 1 (json)

Request

https://joturl.com/a/i1/users/stats/details

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "aggregate": [
      {
        "type": "[type 1]",
        "label": "[label 1]",
        "event": "[generates event?]",
        "count": 8787
      },
      {
        "type": "[...]",
        "label": "[...]",
        "event": "[generates event?]",
        "count": "[...]"
      },
      {
        "type": "[type N]",
        "label": "[label N]",
        "event": "[generates event?]",
        "count": 3111
      }
    ],
    "by_date": {
      "2025-05-28": [
        {
          "type": "[type 1]",
          "label": "[label 1]",
          "event": "[generates event?]",
          "count": 4624
        },
        {
          "type": "[...]",
          "label": "[...]",
          "event": "[generates event?]",
          "count": "[...]"
        },
        {
          "type": "[type N]",
          "label": "[label N]",
          "event": "[generates event?]",
          "count": 8879
        }
      ],
      "[...]": [
        {
          "type": "[type 1]",
          "label": "[label 1]",
          "event": "[generates event?]",
          "count": 6941
        },
        {
          "type": "[...]",
          "label": "[...]",
          "event": "[generates event?]",
          "count": "[...]"
        },
        {
          "type": "[type N]",
          "label": "[label N]",
          "event": "[generates event?]",
          "count": 6774
        }
      ],
      "2025-06-27": [
        {
          "type": "[type 1]",
          "label": "[label 1]",
          "event": "[generates event?]",
          "count": 9333
        },
        {
          "type": "[...]",
          "label": "[...]",
          "event": "[generates event?]",
          "count": "[...]"
        },
        {
          "type": "[type N]",
          "label": "[label N]",
          "event": "[generates event?]",
          "count": 8850
        }
      ]
    }
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/stats/details?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <aggregate>
      <i0>
        <type>[type 1]</type>  
        <label>[label 1]</label>  
        <event>[generates event?]</event>  
        <count>8787</count>  
      </i0>  
      <i1>
        <type>[...]</type>  
        <label>[...]</label>  
        <event>[generates event?]</event>  
        <count>[...]</count>  
      </i1>  
      <i2>
        <type>[type N]</type>  
        <label>[label N]</label>  
        <event>[generates event?]</event>  
        <count>3111</count>  
      </i2>  
    </aggregate>  
    <by_date>
      <2025-05-28>
        <i0>
          <type>[type 1]</type>  
          <label>[label 1]</label>  
          <event>[generates event?]</event>  
          <count>4624</count>  
        </i0>  
        <i1>
          <type>[...]</type>  
          <label>[...]</label>  
          <event>[generates event?]</event>  
          <count>[...]</count>  
        </i1>  
        <i2>
          <type>[type N]</type>  
          <label>[label N]</label>  
          <event>[generates event?]</event>  
          <count>8879</count>  
        </i2>  
      </2025-05-28>  
      <[...]>
        <i0>
          <type>[type 1]</type>  
          <label>[label 1]</label>  
          <event>[generates event?]</event>  
          <count>6941</count>  
        </i0>  
        <i1>
          <type>[...]</type>  
          <label>[...]</label>  
          <event>[generates event?]</event>  
          <count>[...]</count>  
        </i1>  
        <i2>
          <type>[type N]</type>  
          <label>[label N]</label>  
          <event>[generates event?]</event>  
          <count>6774</count>  
        </i2>  
      </[...]>  
      <2025-06-27>
        <i0>
          <type>[type 1]</type>  
          <label>[label 1]</label>  
          <event>[generates event?]</event>  
          <count>9333</count>  
        </i0>  
        <i1>
          <type>[...]</type>  
          <label>[...]</label>  
          <event>[generates event?]</event>  
          <count>[...]</count>  
        </i1>  
        <i2>
          <type>[type N]</type>  
          <label>[label N]</label>  
          <event>[generates event?]</event>  
          <count>8850</count>  
        </i2>  
      </2025-06-27>  
    </by_date>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/stats/details?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_aggregate_0_type=[type 1]
result_aggregate_0_label=[label 1]
result_aggregate_0_event=[generates event?]
result_aggregate_0_count=8787
result_aggregate_1_type=[...]
result_aggregate_1_label=[...]
result_aggregate_1_event=[generates event?]
result_aggregate_1_count=[...]
result_aggregate_2_type=[type N]
result_aggregate_2_label=[label N]
result_aggregate_2_event=[generates event?]
result_aggregate_2_count=3111
result_by_date_2025-05-28_0_type=[type 1]
result_by_date_2025-05-28_0_label=[label 1]
result_by_date_2025-05-28_0_event=[generates event?]
result_by_date_2025-05-28_0_count=4624
result_by_date_2025-05-28_1_type=[...]
result_by_date_2025-05-28_1_label=[...]
result_by_date_2025-05-28_1_event=[generates event?]
result_by_date_2025-05-28_1_count=[...]
result_by_date_2025-05-28_2_type=[type N]
result_by_date_2025-05-28_2_label=[label N]
result_by_date_2025-05-28_2_event=[generates event?]
result_by_date_2025-05-28_2_count=8879
result_by_date_[...]_0_type=[type 1]
result_by_date_[...]_0_label=[label 1]
result_by_date_[...]_0_event=[generates event?]
result_by_date_[...]_0_count=6941
result_by_date_[...]_1_type=[...]
result_by_date_[...]_1_label=[...]
result_by_date_[...]_1_event=[generates event?]
result_by_date_[...]_1_count=[...]
result_by_date_[...]_2_type=[type N]
result_by_date_[...]_2_label=[label N]
result_by_date_[...]_2_event=[generates event?]
result_by_date_[...]_2_count=6774
result_by_date_2025-06-27_0_type=[type 1]
result_by_date_2025-06-27_0_label=[label 1]
result_by_date_2025-06-27_0_event=[generates event?]
result_by_date_2025-06-27_0_count=9333
result_by_date_2025-06-27_1_type=[...]
result_by_date_2025-06-27_1_label=[...]
result_by_date_2025-06-27_1_event=[generates event?]
result_by_date_2025-06-27_1_count=[...]
result_by_date_2025-06-27_2_type=[type N]
result_by_date_2025-06-27_2_label=[label N]
result_by_date_2025-06-27_2_event=[generates event?]
result_by_date_2025-06-27_2_count=8850

Example 4 (plain)

Request

https://joturl.com/a/i1/users/stats/details?format=plain

Query parameters

format = plain

Response

[type 1]
[label 1]
[generates event?]
8787
[...]
[...]
[generates event?]
[...]
[type N]
[label N]
[generates event?]
3111
[type 1]
[label 1]
[generates event?]
4624
[...]
[...]
[generates event?]
[...]
[type N]
[label N]
[generates event?]
8879
[type 1]
[label 1]
[generates event?]
6941
[...]
[...]
[generates event?]
[...]
[type N]
[label N]
[generates event?]
6774
[type 1]
[label 1]
[generates event?]
9333
[...]
[...]
[generates event?]
[...]
[type N]
[label N]
[generates event?]
8850
Optional parameters
parameterdescription
time_intervalENUMtime interval for information extraction, available values: 30, 60, 90 (default: 30)
Return values
parameterdescription
aggregateaggregate view by type
by_dateview by date

/users/stats/summary

access: [READ]

Account-level summary statistics.

Example 1 (json)

Request

https://joturl.com/a/i1/users/stats/summary?fields=conversions_clicks,conversions_clicks_diff_perc,ctas_conversions,ctas_conversions_diff_perc,qrcodes_clicks,qrcodes_clicks_diff_perc,unique_visits,unique_visits_diff_perc,visits,visits_diff_perc

Query parameters

fields = conversions_clicks,conversions_clicks_diff_perc,ctas_conversions,ctas_conversions_diff_perc,qrcodes_clicks,qrcodes_clicks_diff_perc,unique_visits,unique_visits_diff_perc,visits,visits_diff_perc

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": [
      {
        "conversions_clicks": "9",
        "conversions_clicks_diff_perc": "",
        "conversions_clicks_diff_perc14_7": "0",
        "conversions_clicks_diff_perc14_7_min_date": "",
        "conversions_clicks_diff_perc7": "0",
        "conversions_clicks_diff_perc7_min_date": "",
        "ctas_conversions": "28",
        "ctas_conversions_diff_perc": "",
        "ctas_conversions_diff_perc14_7": "0",
        "ctas_conversions_diff_perc14_7_min_date": "",
        "ctas_conversions_diff_perc7": "2",
        "ctas_conversions_diff_perc7_min_date": "2020-10-11",
        "qrcodes_clicks": "334",
        "qrcodes_clicks_diff_perc": 14,
        "qrcodes_clicks_diff_perc14_7": "1",
        "qrcodes_clicks_diff_perc14_7_min_date": "2020-10-01",
        "qrcodes_clicks_diff_perc7": "15",
        "qrcodes_clicks_diff_perc7_min_date": "2020-10-12",
        "unique_visits": "940783",
        "unique_visits_diff_perc": 1.9565,
        "unique_visits_diff_perc14_7": "23",
        "unique_visits_diff_perc14_7_min_date": "2020-09-30",
        "unique_visits_diff_perc7": "68",
        "unique_visits_diff_perc7_min_date": "2020-10-06",
        "visits": "943328",
        "visits_diff_perc": 4.16,
        "visits_diff_perc14_7": "25",
        "visits_diff_perc14_7_min_date": "2020-09-30",
        "visits_diff_perc7": "129",
        "visits_diff_perc7_min_date": "2020-10-06"
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/stats/summary?fields=conversions_clicks,conversions_clicks_diff_perc,ctas_conversions,ctas_conversions_diff_perc,qrcodes_clicks,qrcodes_clicks_diff_perc,unique_visits,unique_visits_diff_perc,visits,visits_diff_perc&format=xml

Query parameters

fields = conversions_clicks,conversions_clicks_diff_perc,ctas_conversions,ctas_conversions_diff_perc,qrcodes_clicks,qrcodes_clicks_diff_perc,unique_visits,unique_visits_diff_perc,visits,visits_diff_perc
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <i0>
        <conversions_clicks>9</conversions_clicks>  
        <conversions_clicks_diff_perc></conversions_clicks_diff_perc>  
        <conversions_clicks_diff_perc14_7>0</conversions_clicks_diff_perc14_7>  
        <conversions_clicks_diff_perc14_7_min_date></conversions_clicks_diff_perc14_7_min_date>  
        <conversions_clicks_diff_perc7>0</conversions_clicks_diff_perc7>  
        <conversions_clicks_diff_perc7_min_date></conversions_clicks_diff_perc7_min_date>  
        <ctas_conversions>28</ctas_conversions>  
        <ctas_conversions_diff_perc></ctas_conversions_diff_perc>  
        <ctas_conversions_diff_perc14_7>0</ctas_conversions_diff_perc14_7>  
        <ctas_conversions_diff_perc14_7_min_date></ctas_conversions_diff_perc14_7_min_date>  
        <ctas_conversions_diff_perc7>2</ctas_conversions_diff_perc7>  
        <ctas_conversions_diff_perc7_min_date>2020-10-11</ctas_conversions_diff_perc7_min_date>  
        <qrcodes_clicks>334</qrcodes_clicks>  
        <qrcodes_clicks_diff_perc>14</qrcodes_clicks_diff_perc>  
        <qrcodes_clicks_diff_perc14_7>1</qrcodes_clicks_diff_perc14_7>  
        <qrcodes_clicks_diff_perc14_7_min_date>2020-10-01</qrcodes_clicks_diff_perc14_7_min_date>  
        <qrcodes_clicks_diff_perc7>15</qrcodes_clicks_diff_perc7>  
        <qrcodes_clicks_diff_perc7_min_date>2020-10-12</qrcodes_clicks_diff_perc7_min_date>  
        <unique_visits>940783</unique_visits>  
        <unique_visits_diff_perc>1.9565</unique_visits_diff_perc>  
        <unique_visits_diff_perc14_7>23</unique_visits_diff_perc14_7>  
        <unique_visits_diff_perc14_7_min_date>2020-09-30</unique_visits_diff_perc14_7_min_date>  
        <unique_visits_diff_perc7>68</unique_visits_diff_perc7>  
        <unique_visits_diff_perc7_min_date>2020-10-06</unique_visits_diff_perc7_min_date>  
        <visits>943328</visits>  
        <visits_diff_perc>4.16</visits_diff_perc>  
        <visits_diff_perc14_7>25</visits_diff_perc14_7>  
        <visits_diff_perc14_7_min_date>2020-09-30</visits_diff_perc14_7_min_date>  
        <visits_diff_perc7>129</visits_diff_perc7>  
        <visits_diff_perc7_min_date>2020-10-06</visits_diff_perc7_min_date>  
      </i0>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/stats/summary?fields=conversions_clicks,conversions_clicks_diff_perc,ctas_conversions,ctas_conversions_diff_perc,qrcodes_clicks,qrcodes_clicks_diff_perc,unique_visits,unique_visits_diff_perc,visits,visits_diff_perc&format=txt

Query parameters

fields = conversions_clicks,conversions_clicks_diff_perc,ctas_conversions,ctas_conversions_diff_perc,qrcodes_clicks,qrcodes_clicks_diff_perc,unique_visits,unique_visits_diff_perc,visits,visits_diff_perc
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_0_conversions_clicks=9
result_data_0_conversions_clicks_diff_perc=
result_data_0_conversions_clicks_diff_perc14_7=0
result_data_0_conversions_clicks_diff_perc14_7_min_date=
result_data_0_conversions_clicks_diff_perc7=0
result_data_0_conversions_clicks_diff_perc7_min_date=
result_data_0_ctas_conversions=28
result_data_0_ctas_conversions_diff_perc=
result_data_0_ctas_conversions_diff_perc14_7=0
result_data_0_ctas_conversions_diff_perc14_7_min_date=
result_data_0_ctas_conversions_diff_perc7=2
result_data_0_ctas_conversions_diff_perc7_min_date=2020-10-11
result_data_0_qrcodes_clicks=334
result_data_0_qrcodes_clicks_diff_perc=14
result_data_0_qrcodes_clicks_diff_perc14_7=1
result_data_0_qrcodes_clicks_diff_perc14_7_min_date=2020-10-01
result_data_0_qrcodes_clicks_diff_perc7=15
result_data_0_qrcodes_clicks_diff_perc7_min_date=2020-10-12
result_data_0_unique_visits=940783
result_data_0_unique_visits_diff_perc=1.9565
result_data_0_unique_visits_diff_perc14_7=23
result_data_0_unique_visits_diff_perc14_7_min_date=2020-09-30
result_data_0_unique_visits_diff_perc7=68
result_data_0_unique_visits_diff_perc7_min_date=2020-10-06
result_data_0_visits=943328
result_data_0_visits_diff_perc=4.16
result_data_0_visits_diff_perc14_7=25
result_data_0_visits_diff_perc14_7_min_date=2020-09-30
result_data_0_visits_diff_perc7=129
result_data_0_visits_diff_perc7_min_date=2020-10-06

Example 4 (plain)

Request

https://joturl.com/a/i1/users/stats/summary?fields=conversions_clicks,conversions_clicks_diff_perc,ctas_conversions,ctas_conversions_diff_perc,qrcodes_clicks,qrcodes_clicks_diff_perc,unique_visits,unique_visits_diff_perc,visits,visits_diff_perc&format=plain

Query parameters

fields = conversions_clicks,conversions_clicks_diff_perc,ctas_conversions,ctas_conversions_diff_perc,qrcodes_clicks,qrcodes_clicks_diff_perc,unique_visits,unique_visits_diff_perc,visits,visits_diff_perc
format = plain

Response

9

0

0

28

0

2
2020-10-11
334
14
1
2020-10-01
15
2020-10-12
940783
1.9565
23
2020-09-30
68
2020-10-06
943328
4.16
25
2020-09-30
129
2020-10-06
Required parameters
parameterdescription
fieldsARRAYcomma separated list of fields to return, available fields: conversions_clicks, conversions_clicks_diff_perc, ctas_conversions, ctas_conversions_diff_perc, ctas_events, ctas_events_diff_perc, ctas_form_clicks, ctas_form_clicks_diff_perc, ctas_redirect_to_destination_clicks, ctas_redirect_to_destination_clicks_diff_perc, ctas_social_connect_clicks, ctas_social_connect_clicks_diff_perc, events, events_diff_perc, events_last_30days, events_last_30days_diff_perc, external_api_clicks, external_api_clicks_diff_perc, internal_api_clicks, internal_api_clicks_diff_perc, qrcodes_clicks, qrcodes_clicks_diff_perc, unique_visits, unique_visits_diff_perc, visits, visits_diff_perc
Optional parameters
parameterdescription
project_idIDif passed, statistics are filtered by this project ID
Return values
parameterdescription
dataarray containing required statistics

/users/watchdogs

/users/watchdogs/alerts

/users/watchdogs/alerts/count

access: [READ]

This method returns the number of watchdog's alerts, if any.

Example 1 (json)

Request

https://joturl.com/a/i1/users/watchdogs/alerts/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": "9+"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/watchdogs/alerts/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>9+</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/watchdogs/alerts/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=9+

Example 4 (plain)

Request

https://joturl.com/a/i1/users/watchdogs/alerts/count?format=plain

Query parameters

format = plain

Response

9+
Return values
parameterdescription
countnumber of alerts if it is less than 10, 9+ otherwise
/users/watchdogs/alerts/reset_alerts_flag

access: [READ]

This method reset the flag that our engine uses to send emails from the watchdog, by resetting this flag no emails will be sent.

Example 1 (json)

Request

https://joturl.com/a/i1/users/watchdogs/alerts/reset_alerts_flag

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/watchdogs/alerts/reset_alerts_flag?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>1</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/users/watchdogs/alerts/reset_alerts_flag?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=1

Example 4 (plain)

Request

https://joturl.com/a/i1/users/watchdogs/alerts/reset_alerts_flag?format=plain

Query parameters

format = plain

Response

1
Return values
parameterdescription
count1 on success, 0 if the flag was already reset

/utms

/utms/add

access: [WRITE]

This method adds a new UTM template.

Example 1 (json)

Request

https://joturl.com/a/i1/utms/add?name=JotUrl+campaign&utm_source=facebook

Query parameters

      name = JotUrl campaign
utm_source = facebook

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "name": "JotUrl campaign",
    "utm_source": "facebook",
    "added": 1,
    "id": "e4bcb7b27017e4d85abbc2b9f4199553",
    "utm_medium": "",
    "utm_campaign": "",
    "utm_term": "",
    "utm_content": ""
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/utms/add?name=JotUrl+campaign&utm_source=facebook&format=xml

Query parameters

      name = JotUrl campaign
utm_source = facebook
    format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <name>JotUrl campaign</name>  
    <utm_source>facebook</utm_source>  
    <added>1</added>  
    <id>e4bcb7b27017e4d85abbc2b9f4199553</id>  
    <utm_medium></utm_medium>  
    <utm_campaign></utm_campaign>  
    <utm_term></utm_term>  
    <utm_content></utm_content>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/utms/add?name=JotUrl+campaign&utm_source=facebook&format=txt

Query parameters

      name = JotUrl campaign
utm_source = facebook
    format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_name=JotUrl campaign
result_utm_source=facebook
result_added=1
result_id=e4bcb7b27017e4d85abbc2b9f4199553
result_utm_medium=
result_utm_campaign=
result_utm_term=
result_utm_content=

Example 4 (plain)

Request

https://joturl.com/a/i1/utms/add?name=JotUrl+campaign&utm_source=facebook&format=plain

Query parameters

      name = JotUrl campaign
utm_source = facebook
    format = plain

Response

JotUrl campaign
facebook
1
e4bcb7b27017e4d85abbc2b9f4199553




Required parameters
parameterdescriptionmax length
nameSTRINGUTM template name255
utm_sourceSTRINGutm_source parameter150
Optional parameters
parameterdescriptionmax length
utm_campaignSTRINGutm_campaign parameter150
utm_contentSTRINGutm_content parameter150
utm_mediumSTRINGutm_medium parameter150
utm_termSTRINGutm_term parameter150
Return values
parameterdescription
added1 on success, 0 otherwise
idID of the UTM template
nameecho back of the name input parameter
utm_campaignecho back of the utm_campaign input parameter
utm_contentecho back of the utm_content input parameter
utm_mediumecho back of the utm_medium input parameter
utm_sourceecho back of the utm_source input parameter
utm_termecho back of the utm_term input parameter

/utms/count

access: [READ]

This method returns the number of UTM templates.

Example 1 (json)

Request

https://joturl.com/a/i1/utms/count

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 5
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/utms/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>5</count>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/utms/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=5

Example 4 (plain)

Request

https://joturl.com/a/i1/utms/count?format=plain

Query parameters

format = plain

Response

5
Optional parameters
parameterdescription
searchSTRINGfilters UTM templates to be extracted by searching them
Return values
parameterdescription
countthe number of UTM templates

/utms/delete

access: [WRITE]

This method deletes a UTM template.

Example 1 (json)

Request

https://joturl.com/a/i1/utms/delete?id=90b9eab8faa7ca92df08cd302f985673

Query parameters

id = 90b9eab8faa7ca92df08cd302f985673

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "deleted": 1
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/utms/delete?id=90b9eab8faa7ca92df08cd302f985673&format=xml

Query parameters

    id = 90b9eab8faa7ca92df08cd302f985673
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/utms/delete?id=90b9eab8faa7ca92df08cd302f985673&format=txt

Query parameters

    id = 90b9eab8faa7ca92df08cd302f985673
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_deleted=1

Example 4 (plain)

Request

https://joturl.com/a/i1/utms/delete?id=90b9eab8faa7ca92df08cd302f985673&format=plain

Query parameters

    id = 90b9eab8faa7ca92df08cd302f985673
format = plain

Response

1
Required parameters
parameterdescription
idIDID of the UTM templates to delete
Optional parameters
parameterdescription
confirmBOOLEANIf 1 this method deletes the UTM template even if it is linked to a tracking link
Return values
parameterdescription
deleted1 on success, 0 otherwise

/utms/edit

access: [WRITE]

This method edits a UTM template.

Example 1 (json)

Request

https://joturl.com/a/i1/utms/edit?id=d15bc67b7f4d281ad75a779b209b6603&name=JotUrl+campaign&utm_source=facebook

Query parameters

        id = d15bc67b7f4d281ad75a779b209b6603
      name = JotUrl campaign
utm_source = facebook

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "id": "d15bc67b7f4d281ad75a779b209b6603",
    "name": "JotUrl campaign",
    "utm_source": "facebook",
    "updated": 1,
    "utm_medium": "",
    "utm_campaign": "",
    "utm_term": "",
    "utm_content": ""
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/utms/edit?id=d15bc67b7f4d281ad75a779b209b6603&name=JotUrl+campaign&utm_source=facebook&format=xml

Query parameters

        id = d15bc67b7f4d281ad75a779b209b6603
      name = JotUrl campaign
utm_source = facebook
    format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <id>d15bc67b7f4d281ad75a779b209b6603</id>  
    <name>JotUrl campaign</name>  
    <utm_source>facebook</utm_source>  
    <updated>1</updated>  
    <utm_medium></utm_medium>  
    <utm_campaign></utm_campaign>  
    <utm_term></utm_term>  
    <utm_content></utm_content>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/utms/edit?id=d15bc67b7f4d281ad75a779b209b6603&name=JotUrl+campaign&utm_source=facebook&format=txt

Query parameters

        id = d15bc67b7f4d281ad75a779b209b6603
      name = JotUrl campaign
utm_source = facebook
    format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_id=d15bc67b7f4d281ad75a779b209b6603
result_name=JotUrl campaign
result_utm_source=facebook
result_updated=1
result_utm_medium=
result_utm_campaign=
result_utm_term=
result_utm_content=

Example 4 (plain)

Request

https://joturl.com/a/i1/utms/edit?id=d15bc67b7f4d281ad75a779b209b6603&name=JotUrl+campaign&utm_source=facebook&format=plain

Query parameters

        id = d15bc67b7f4d281ad75a779b209b6603
      name = JotUrl campaign
utm_source = facebook
    format = plain

Response

d15bc67b7f4d281ad75a779b209b6603
JotUrl campaign
facebook
1




Required parameters
parameterdescription
idIDID of the UTM template to edit
Optional parameters
parameterdescriptionmax length
nameSTRINGUTM template name255
utm_campaignSTRINGutm_campaign parameter150
utm_contentSTRINGutm_content parameter150
utm_mediumSTRINGutm_medium parameter150
utm_sourceSTRINGutm_source parameter150
utm_termSTRINGutm_term parameter150
Return values
parameterdescription
idecho back of the id input parameter
nameecho back of the name input parameter
updated1 on success, 0 otherwise
utm_campaignecho back of the utm_campaign input parameter
utm_contentecho back of the utm_content input parameter
utm_mediumecho back of the utm_medium input parameter
utm_sourceecho back of the utm_source input parameter
utm_termecho back of the utm_term input parameter

/utms/info

access: [READ]

This method returns info about a UTM template.

Example 1 (json)

Request

https://joturl.com/a/i1/utms/info?fields=id,name,utm_campaign,utm_content,utm_medium,utm_source,utm_term&gdpr_id=70cebb7173f4eb641f92d98d9eb1e523

Query parameters

 fields = id,name,utm_campaign,utm_content,utm_medium,utm_source,utm_term
gdpr_id = 70cebb7173f4eb641f92d98d9eb1e523

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "data": [
      {
        "id": "70cebb7173f4eb641f92d98d9eb1e523",
        "name": "JotUrl campaign",
        "utm_source": "facebook",
        "utm_medium": "",
        "utm_campaign": "",
        "utm_term": "",
        "utm_content": ""
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/utms/info?fields=id,name,utm_campaign,utm_content,utm_medium,utm_source,utm_term&gdpr_id=70cebb7173f4eb641f92d98d9eb1e523&format=xml

Query parameters

 fields = id,name,utm_campaign,utm_content,utm_medium,utm_source,utm_term
gdpr_id = 70cebb7173f4eb641f92d98d9eb1e523
 format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <data>
      <i0>
        <id>70cebb7173f4eb641f92d98d9eb1e523</id>  
        <name>JotUrl campaign</name>  
        <utm_source>facebook</utm_source>  
        <utm_medium></utm_medium>  
        <utm_campaign></utm_campaign>  
        <utm_term></utm_term>  
        <utm_content></utm_content>  
      </i0>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/utms/info?fields=id,name,utm_campaign,utm_content,utm_medium,utm_source,utm_term&gdpr_id=70cebb7173f4eb641f92d98d9eb1e523&format=txt

Query parameters

 fields = id,name,utm_campaign,utm_content,utm_medium,utm_source,utm_term
gdpr_id = 70cebb7173f4eb641f92d98d9eb1e523
 format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_data_0_id=70cebb7173f4eb641f92d98d9eb1e523
result_data_0_name=JotUrl campaign
result_data_0_utm_source=facebook
result_data_0_utm_medium=
result_data_0_utm_campaign=
result_data_0_utm_term=
result_data_0_utm_content=

Example 4 (plain)

Request

https://joturl.com/a/i1/utms/info?fields=id,name,utm_campaign,utm_content,utm_medium,utm_source,utm_term&gdpr_id=70cebb7173f4eb641f92d98d9eb1e523&format=plain

Query parameters

 fields = id,name,utm_campaign,utm_content,utm_medium,utm_source,utm_term
gdpr_id = 70cebb7173f4eb641f92d98d9eb1e523
 format = plain

Response

70cebb7173f4eb641f92d98d9eb1e523
JotUrl campaign
facebook




Required parameters
parameterdescription
fieldsARRAYcomma-separated list of fields to return, available fields: count, id, name, utm_campaign, utm_content, utm_medium, utm_source, utm_term
idIDID of the UTM template
Return values
parameterdescription
dataarray containing information on the UTM templates, returned information depends on the fields input parameter.

/utms/list

access: [READ]

This method returns a list of UTM templates.

Example 1 (json)

Request

https://joturl.com/a/i1/utms/list?fields=count,id,name,utm_campaign,utm_content,utm_medium,utm_source,utm_term

Query parameters

fields = count,id,name,utm_campaign,utm_content,utm_medium,utm_source,utm_term

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "count": 1,
    "data": [
      {
        "id": "fbae908da799e862318b71136d76a1d1",
        "name": "JotUrl campaign",
        "utm_source": "facebook",
        "utm_medium": "",
        "utm_campaign": "",
        "utm_term": "",
        "utm_content": ""
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/utms/list?fields=count,id,name,utm_campaign,utm_content,utm_medium,utm_source,utm_term&format=xml

Query parameters

fields = count,id,name,utm_campaign,utm_content,utm_medium,utm_source,utm_term
format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <count>1</count>  
    <data>
      <i0>
        <id>fbae908da799e862318b71136d76a1d1</id>  
        <name>JotUrl campaign</name>  
        <utm_source>facebook</utm_source>  
        <utm_medium></utm_medium>  
        <utm_campaign></utm_campaign>  
        <utm_term></utm_term>  
        <utm_content></utm_content>  
      </i0>  
    </data>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/utms/list?fields=count,id,name,utm_campaign,utm_content,utm_medium,utm_source,utm_term&format=txt

Query parameters

fields = count,id,name,utm_campaign,utm_content,utm_medium,utm_source,utm_term
format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_count=1
result_data_0_id=fbae908da799e862318b71136d76a1d1
result_data_0_name=JotUrl campaign
result_data_0_utm_source=facebook
result_data_0_utm_medium=
result_data_0_utm_campaign=
result_data_0_utm_term=
result_data_0_utm_content=

Example 4 (plain)

Request

https://joturl.com/a/i1/utms/list?fields=count,id,name,utm_campaign,utm_content,utm_medium,utm_source,utm_term&format=plain

Query parameters

fields = count,id,name,utm_campaign,utm_content,utm_medium,utm_source,utm_term
format = plain

Response

1
fbae908da799e862318b71136d76a1d1
JotUrl campaign
facebook




Required parameters
parameterdescription
fieldsARRAYcomma-separated list of fields to return, available fields: count, id, name, utm_campaign, utm_content, utm_medium, utm_source, utm_term
Optional parameters
parameterdescription
lengthINTEGERextracts this number of UTM templates (maxmimum allowed: 100)
orderbyARRAYorders UTM templates by field, available fields: id, name, utm_campaign, utm_content, utm_medium, utm_source, utm_term
searchSTRINGfilters UTM templates to be extracted by searching them
sortSTRINGsorts UTM templates in ascending (ASC) or descending (DESC) order
startINTEGERstarts to extract UTM templates from this position
Return values
parameterdescription
count[OPTIONAL] total number of UTM templates, returned only if count is passed in fields
dataarray containing information on the UTM templates, returned information depends on the fields input parameter.

/watchdogs

/watchdogs/clone

access: [WRITE]

Clone the qrcodes configuration from a tracking link to another.

Example 1 (json)

Request

https://joturl.com/a/i1/watchdogs/clone?from_url_id=0012149d3daccde6bddc4d7758ec1434&to_url_id=485f0c2cb500443c4bac8c82380c6b32

Query parameters

from_url_id = 0012149d3daccde6bddc4d7758ec1434
  to_url_id = 485f0c2cb500443c4bac8c82380c6b32

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "cloned": 0
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/watchdogs/clone?from_url_id=0012149d3daccde6bddc4d7758ec1434&to_url_id=485f0c2cb500443c4bac8c82380c6b32&format=xml

Query parameters

from_url_id = 0012149d3daccde6bddc4d7758ec1434
  to_url_id = 485f0c2cb500443c4bac8c82380c6b32
     format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <cloned>0</cloned>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/watchdogs/clone?from_url_id=0012149d3daccde6bddc4d7758ec1434&to_url_id=485f0c2cb500443c4bac8c82380c6b32&format=txt

Query parameters

from_url_id = 0012149d3daccde6bddc4d7758ec1434
  to_url_id = 485f0c2cb500443c4bac8c82380c6b32
     format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_cloned=0

Example 4 (plain)

Request

https://joturl.com/a/i1/watchdogs/clone?from_url_id=0012149d3daccde6bddc4d7758ec1434&to_url_id=485f0c2cb500443c4bac8c82380c6b32&format=plain

Query parameters

from_url_id = 0012149d3daccde6bddc4d7758ec1434
  to_url_id = 485f0c2cb500443c4bac8c82380c6b32
     format = plain

Response

0
Required parameters
parameterdescription
from_url_idIDID of the tracking link you want to copy watchdog configuration from
to_url_idIDID of the tracking link you want to copy watchdog configuration to
Return values
parameterdescription
cloned1 on success, 0 otherwise

/watchdogs/property

access: [READ]

This method returns a list of properties of the watchdog (content monitoring).

Example 1 (json)

Request

https://joturl.com/a/i1/watchdogs/property

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": "",
    "rate": 0
  },
  "result": {
    "watchdogs": [
      {
        "type": "1D",
        "title": "1 check per day",
        "limit": 1800
      }
    ],
    "spiders": [
      {
        "id": "DISABLE_ALL",
        "title": "Disable all spiders. No check will be performed.",
        "short": "Disable ALL",
        "params": {
          "video": 0,
          "time": 0,
          "texts": 0,
          "threshold": 0
        }
      },
      {
        "id": "AUTOMATIC",
        "title": "The spider will be automatically selected by the system. In most cases the system will choose the spider PING without any control over videos.",
        "short": "Automatic",
        "params": {
          "video": 0,
          "time": 0,
          "texts": 0,
          "threshold": 0
        }
      },
      {
        "id": "HTML_PING",
        "title": "Interrupted and redirected URL check (PING.)",
        "short": "PING",
        "params": {
          "video": 1,
          "time": 1,
          "texts": 0,
          "threshold": 0
        }
      },
      {
        "id": "HTML_TITLE_H1",
        "title": "Checks for interrupted or redirected URLs and changes in title and\/or h1 tag of the page.",
        "short": "TITLE and H1",
        "params": {
          "video": 1,
          "time": 1,
          "texts": 0,
          "threshold": 0
        }
      },
      {
        "id": "HTML_TEXTS",
        "title": "Checks for interrupted or redirected URLs and changes in the texts of the page (exluding numbers and tags.)",
        "short": "TEXT of the PAGE",
        "params": {
          "video": 1,
          "time": 1,
          "texts": 1,
          "threshold": 0
        }
      },
      {
        "id": "HTML_ALL",
        "title": "Checks for interrupted or redirected URLs and changes in the page (including numbers and tags.)",
        "short": "WHOLE PAGE",
        "params": {
          "video": 1,
          "time": 1,
          "texts": 1,
          "threshold": 0
        }
      },
      {
        "id": "HTML_BLOCKS",
        "title": "Checks for interrupted or redirected URLs and changes in the blocks of text that are extracted from the page with data mining algorithm.",
        "short": "DATA MINING",
        "params": {
          "video": 1,
          "time": 1,
          "texts": 0,
          "threshold": 1
        }
      },
      {
        "id": "HTML_DISABLED",
        "title": "Only the video spider will be activated (spider HTML will be disabled.)",
        "short": "HTML disabled",
        "params": {
          "video": 0,
          "time": 0,
          "texts": 0,
          "threshold": 0
        }
      }
    ],
    "frequencies": [
      {
        "label": "do_not_send",
        "value": ""
      },
      {
        "label": "immediately",
        "value": 0
      },
      {
        "label": "day",
        "value": 1
      },
      {
        "label": "day",
        "value": 3
      },
      {
        "label": "day",
        "value": 7
      },
      {
        "label": "day",
        "value": 15
      },
      {
        "label": "day",
        "value": 30
      }
    ]
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/watchdogs/property?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
    <error></error>  
    <rate>0</rate>  
  </status>  
  <result>
    <watchdogs>
      <i0>
        <type>1D</type>  
        <title>1 check per day</title>  
        <limit>1800</limit>  
      </i0>  
    </watchdogs>  
    <spiders>
      <i0>
        <id>DISABLE_ALL</id>  
        <title>Disable all spiders. No check will be performed.</title>  
        <short>Disable ALL</short>  
        <params>
          <video>0</video>  
          <time>0</time>  
          <texts>0</texts>  
          <threshold>0</threshold>  
        </params>  
      </i0>  
      <i1>
        <id>AUTOMATIC</id>  
        <title>The spider will be automatically selected by the system. In most cases the system will choose the spider PING without any control over videos.</title>  
        <short>Automatic</short>  
        <params>
          <video>0</video>  
          <time>0</time>  
          <texts>0</texts>  
          <threshold>0</threshold>  
        </params>  
      </i1>  
      <i2>
        <id>HTML_PING</id>  
        <title>Interrupted and redirected URL check (PING.)</title>  
        <short>PING</short>  
        <params>
          <video>1</video>  
          <time>1</time>  
          <texts>0</texts>  
          <threshold>0</threshold>  
        </params>  
      </i2>  
      <i3>
        <id>HTML_TITLE_H1</id>  
        <title>Checks for interrupted or redirected URLs and changes in title and/or h1 tag of the page.</title>  
        <short>TITLE and H1</short>  
        <params>
          <video>1</video>  
          <time>1</time>  
          <texts>0</texts>  
          <threshold>0</threshold>  
        </params>  
      </i3>  
      <i4>
        <id>HTML_TEXTS</id>  
        <title>Checks for interrupted or redirected URLs and changes in the texts of the page (exluding numbers and tags.)</title>  
        <short>TEXT of the PAGE</short>  
        <params>
          <video>1</video>  
          <time>1</time>  
          <texts>1</texts>  
          <threshold>0</threshold>  
        </params>  
      </i4>  
      <i5>
        <id>HTML_ALL</id>  
        <title>Checks for interrupted or redirected URLs and changes in the page (including numbers and tags.)</title>  
        <short>WHOLE PAGE</short>  
        <params>
          <video>1</video>  
          <time>1</time>  
          <texts>1</texts>  
          <threshold>0</threshold>  
        </params>  
      </i5>  
      <i6>
        <id>HTML_BLOCKS</id>  
        <title>Checks for interrupted or redirected URLs and changes in the blocks of text that are extracted from the page with data mining algorithm.</title>  
        <short>DATA MINING</short>  
        <params>
          <video>1</video>  
          <time>1</time>  
          <texts>0</texts>  
          <threshold>1</threshold>  
        </params>  
      </i6>  
      <i7>
        <id>HTML_DISABLED</id>  
        <title>Only the video spider will be activated (spider HTML will be disabled.)</title>  
        <short>HTML disabled</short>  
        <params>
          <video>0</video>  
          <time>0</time>  
          <texts>0</texts>  
          <threshold>0</threshold>  
        </params>  
      </i7>  
    </spiders>  
    <frequencies>
      <i0>
        <label>do_not_send</label>  
        <value></value>  
      </i0>  
      <i1>
        <label>immediately</label>  
        <value>0</value>  
      </i1>  
      <i2>
        <label>day</label>  
        <value>1</value>  
      </i2>  
      <i3>
        <label>day</label>  
        <value>3</value>  
      </i3>  
      <i4>
        <label>day</label>  
        <value>7</value>  
      </i4>  
      <i5>
        <label>day</label>  
        <value>15</value>  
      </i5>  
      <i6>
        <label>day</label>  
        <value>30</value>  
      </i6>  
    </frequencies>  
  </result>  
</response>

Example 3 (txt)

Request

https://joturl.com/a/i1/watchdogs/property?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
status_error=
status_rate=0
result_watchdogs_0_type=1D
result_watchdogs_0_title=1 check per day
result_watchdogs_0_limit=1800
result_spiders_0_id=DISABLE_ALL
result_spiders_0_title=Disable all spiders. No check will be performed.
result_spiders_0_short=Disable ALL
result_spiders_0_params_video=0
result_spiders_0_params_time=0
result_spiders_0_params_texts=0
result_spiders_0_params_threshold=0
result_spiders_1_id=AUTOMATIC
result_spiders_1_title=The spider will be automatically selected by the system. In most cases the system will choose the spider PING without any control over videos.
result_spiders_1_short=Automatic
result_spiders_1_params_video=0
result_spiders_1_params_time=0
result_spiders_1_params_texts=0
result_spiders_1_params_threshold=0
result_spiders_2_id=HTML_PING
result_spiders_2_title=Interrupted and redirected URL check (PING.)
result_spiders_2_short=PING
result_spiders_2_params_video=1
result_spiders_2_params_time=1
result_spiders_2_params_texts=0
result_spiders_2_params_threshold=0
result_spiders_3_id=HTML_TITLE_H1
result_spiders_3_title=Checks for interrupted or redirected URLs and changes in title and/or h1 tag of the page.
result_spiders_3_short=TITLE and H1
result_spiders_3_params_video=1
result_spiders_3_params_time=1
result_spiders_3_params_texts=0
result_spiders_3_params_threshold=0
result_spiders_4_id=HTML_TEXTS
result_spiders_4_title=Checks for interrupted or redirected URLs and changes in the texts of the page (exluding numbers and tags.)
result_spiders_4_short=TEXT of the PAGE
result_spiders_4_params_video=1
result_spiders_4_params_time=1
result_spiders_4_params_texts=1
result_spiders_4_params_threshold=0
result_spiders_5_id=HTML_ALL
result_spiders_5_title=Checks for interrupted or redirected URLs and changes in the page (including numbers and tags.)
result_spiders_5_short=WHOLE PAGE
result_spiders_5_params_video=1
result_spiders_5_params_time=1
result_spiders_5_params_texts=1
result_spiders_5_params_threshold=0
result_spiders_6_id=HTML_BLOCKS
result_spiders_6_title=Checks for interrupted or redirected URLs and changes in the blocks of text that are extracted from the page with data mining algorithm.
result_spiders_6_short=DATA MINING
result_spiders_6_params_video=1
result_spiders_6_params_time=1
result_spiders_6_params_texts=0
result_spiders_6_params_threshold=1
result_spiders_7_id=HTML_DISABLED
result_spiders_7_title=Only the video spider will be activated (spider HTML will be disabled.)
result_spiders_7_short=HTML disabled
result_spiders_7_params_video=0
result_spiders_7_params_time=0
result_spiders_7_params_texts=0
result_spiders_7_params_threshold=0
result_frequencies_0_label=do_not_send
result_frequencies_0_value=
result_frequencies_1_label=immediately
result_frequencies_1_value=0
result_frequencies_2_label=day
result_frequencies_2_value=1
result_frequencies_3_label=day
result_frequencies_3_value=3
result_frequencies_4_label=day
result_frequencies_4_value=7
result_frequencies_5_label=day
result_frequencies_5_value=15
result_frequencies_6_label=day
result_frequencies_6_value=30

Example 4 (plain)

Request

https://joturl.com/a/i1/watchdogs/property?format=plain

Query parameters

format = plain

Response

1D
1 check per day
1800
DISABLE_ALL
Disable all spiders. No check will be performed.
Disable ALL
0
0
0
0
AUTOMATIC
The spider will be automatically selected by the system. In most cases the system will choose the spider PING without any control over videos.
Automatic
0
0
0
0
HTML_PING
Interrupted and redirected URL check (PING.)
PING
1
1
0
0
HTML_TITLE_H1
Checks for interrupted or redirected URLs and changes in title and/or h1 tag of the page.
TITLE and H1
1
1
0
0
HTML_TEXTS
Checks for interrupted or redirected URLs and changes in the texts of the page (exluding numbers and tags.)
TEXT of the PAGE
1
1
1
0
HTML_ALL
Checks for interrupted or redirected URLs and changes in the page (including numbers and tags.)
WHOLE PAGE
1
1
1
0
HTML_BLOCKS
Checks for interrupted or redirected URLs and changes in the blocks of text that are extracted from the page with data mining algorithm.
DATA MINING
1
1
0
1
HTML_DISABLED
Only the video spider will be activated (spider HTML will be disabled.)
HTML disabled
0
0
0
0
do_not_send

immediately
0
day
1
day
3
day
7
day
15
day
30
Return values
parameterdescription
frequencieslist of frequencies available to the logged user
spiderslist of spiders available to the logged user
watchdogslist of watchdogs available to the logged user

API reference (beta)

/ctas

/ctas/add

access: [WRITE]

Add a call to action template for the user logged in.

Example 1 (json)

Request

https://joturl.com/a/i1/ctas/add?name=calltoactionname&type=button&brand_id=1234abcde

Query parameters

    name = calltoactionname
    type = button
brand_id = 1234abcde

Response

{
  "status": {
    "code": 200,
    "text": "OK"
  },
  "result": {
    "id": "65794b5563376a7a354f6c756b42625946636d2f47773d3d",
    "name": "name"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/ctas/add?format=xml&name=calltoactionname&type=button&brand_id=1234abcde

Query parameters

  format = xml
    name = calltoactionname
    type = button
brand_id = 1234abcde

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
  </status>  
  <result>
    <id>65794b5563376a7a354f6c756b42625946636d2f47773d3d</id>  
    <name>name</name>  
  </result>  
</response>

Example 3 (plain)

Request

https://joturl.com/a/i1/ctas/add?format=plain&name=calltoactionname&type=button&brand_id=1234abcde

Query parameters

  format = plain
    name = calltoactionname
    type = button
brand_id = 1234abcde

Response

65794b5563376a7a354f6c756b42625946636d2f47773d3d
name
Required parameters
parameterdescription
namename of the call to action
typetype of the call to action, for a complete list of types see the method i1/ctas/property
Optional parameters
parameterdescription
brand_idID of the desired brand
paramsparameters of the call to action, for a complete list of parameters see the method i1/ctas/property
Return values
parameterdescription
dateNA
idID of the call to action
namename of the call to action
typetype of the call to action, for a complete list of types see the method i1/ctas/property

/ctas/edit

access: [WRITE]

Edit a call to action template for the user logged in.

Example 1 (json)

Request

https://joturl.com/a/i1/ctas/edit?id=1234abc&name=calltoactionname&type=button&brand_id=1234abcde

Query parameters

      id = 1234abc
    name = calltoactionname
    type = button
brand_id = 1234abcde

Response

{
  "status": {
    "code": 200,
    "text": "OK"
  },
  "result": {
    "id": "65794b5563376a7a354f6c756b42625946636d2f47773d3d",
    "name": "name"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/ctas/edit?id=1234abc&name=calltoactionname&type=button&brand_id=1234abcde

Query parameters

      id = 1234abc
    name = calltoactionname
    type = button
brand_id = 1234abcde

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
  </status>  
  <result>
    <id>65794b5563376a7a354f6c756b42625946636d2f47773d3d</id>  
    <name>name</name>  
  </result>  
</response>

Example 3 (plain)

Request

https://joturl.com/a/i1/ctas/edit?id=1234abc&name=calltoactionname&type=button&brand_id=1234abcde

Query parameters

      id = 1234abc
    name = calltoactionname
    type = button
brand_id = 1234abcde

Response

65794b5563376a7a354f6c756b42625946636d2f47773d3d
name
Required parameters
parameterdescription
idID of the call to action
Optional parameters
parameterdescription
brand_idID of the desired brand
namename of the call to action
paramsparameters of the call to action, for a complete list of parameters see the method i1/ctas/property
typetype of the call to action, for a complete list of types see the method i1/ctas/property
Return values
parameterdescription
idID of the call to action
namename of the call to action

/ctas/info

access: [READ]

This method returns information specified in a comma separated input called fields about a cta

Example 1 (xml)

Request

https://joturl.com/a/i1/ctas/info?format=xml&id=123456&fields=name,type

Query parameters

format = xml
    id = 123456
fields = name,type

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
  </status>  
  <result></result>  
</response>

Example 2 (txt)

Request

https://joturl.com/a/i1/ctas/info?format=txt&id=123456&fields=name,type

Query parameters

format = txt
    id = 123456
fields = name,type

Response

status_code=200
status_text=OK
result=

Example 3 (plain)

Request

https://joturl.com/a/i1/ctas/info?format=plain&id=123456&fields=name,type

Query parameters

format = plain
    id = 123456
fields = name,type

Response

Required parameters
parameterdescription
fieldscomma separated list of CTA fields [id,type,name,brand_id,params,clicks,conversions]
idID of the call to action
Return values
parameterdescription
dataNA

/ctas/list

access: [READ]

This method returns a list of user's call to action data, specified in a comma separated input called fields.

Example 1 (xml)

Request

https://joturl.com/a/i1/ctas/list?format=xml&fields=name,id

Query parameters

format = xml
fields = name,id

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
  </status>  
  <result>
    <item0>
      <id>1a2b3c4d123456</id>  
      <name>conversion name</name>  
    </item0>  
    <item1>
      <id>1a2b3c4d123456</id>  
      <name>call to action name</name>  
    </item1>  
  </result>  
</response>

Example 2 (txt)

Request

https://joturl.com/a/i1/ctas/list?format=txt&fields=name,id

Query parameters

format = txt
fields = name,id

Response

status_code=200
status_text=OK
result_item0_id=1a2b3c4d123456
result_item0_name=conversion name
result_item1_id=1a2b3c4d123456
result_item1_name=call to action name

Example 3 (plain)

Request

https://joturl.com/a/i1/ctas/list?format=plain&fields=name,id

Query parameters

format = plain
fields = name,id

Response

1a2b3c4d123456
conversion name
1a2b3c4d123456
call to action name
Required parameters
parameterdescription
fieldscomma separated list of CTA fields [id,type,name,brand_id,params,clicks,conversions,count,performance]. You can use the special field count to retrieve the number of call to actions
Optional parameters
parameterdescription
lengthnumber of items to be extracted
orderbyorder items by one field [id,type,name,brand_id,params,clicks,conversions,count,performance]. You can use the special field performance to order call to actions by performance. Use sort for ascending or descending order. Default is orderby = id
searchfilter items by searching them
sortto be used in conjunction with orderby to select the ascending or descending order [ASC|DESC]. Default is sort = ASC
startindex from which the list will be extracted
typescomma separated list of types to be extracted
Return values
parameterdescription
dataNA

/ctas/preview

access: [READ]

This method returns an html preview of a cta, using custom parameters or using an existing call to action

Example 1 (xml)

Request

https://joturl.com/a/i1/ctas/preview?format=xml&id=123456

Query parameters

format = xml
    id = 123456

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
  </status>  
  <result><[CDATA[<html><head>[...]</head><body>[...]</body></html>]]></result>  
</response>

Example 2 (txt)

Request

https://joturl.com/a/i1/ctas/preview?format=txt&id=123456

Query parameters

format = txt
    id = 123456

Response

status_code=200
status_text=OK
result=[...][...]

Example 3 (plain)

Request

https://joturl.com/a/i1/ctas/preview?format=plain&id=123456

Query parameters

format = plain
    id = 123456

Response

Optional parameters
parameterdescription
idID of the call to action
paramsparameters of the call to action, for a complete list of parameters see the method i1/ctas/property
Return values
parameterdescription
htmlNA

/ctas/privatekey

access: [READ]

This method returns the user's private key.

Example 1 (json)

Request

https://joturl.com/a/i1/ctas/privatekey

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": ""
  },
  "result": {
    "privatekey": "01234567890123456789"
  }
}
Return values
parameterdescription
privatekeyNA

/ctas/property

access: [READ]

This method returns a list of property of a call to action with detailed information on them.

Example 1 (json)

Request

https://joturl.com/a/i1/ctas/property

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": ""
  },
  "result": {
    "label": "Tipo Call to Action",
    "types": {
      "appsnip": {
        "label": "App Snip"
      },
      "banner": {
        "label": "Banner"
      },
      "button": {
        "label": "Bottone"
      },
      "form": {
        "label": "Form"
      },
      "socialconnect": {
        "label": "Connessione ai Social Network"
      },
      "textlink": {
        "label": "Text Link"
      }
    }
  }
}

Example 2 (json)

Request

https://joturl.com/a/i1/ctas/property?types=form

Query parameters

types = form

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": ""
  },
  "result": {
    "label": "Call to Action type",
    "types": {
      "form": {
        "label": "Form",
        "base": {
          "name": {
            "type": "text",
            "label": "Template name"
          },
          "type": {
            "type": "text",
            "label": "Call to action\u2019s type"
          },
          "brand_id": {
            "type": "text",
            "label": "User brand identifier for a call to action"
          },
          "one_time_code_validity": {
            "type": "select",
            "label": "Period of validity of the one-time code",
            "options": [
              {
                "value": "10",
                "label": "10 minutes"
              },
              {
                "value": "20",
                "label": "20 minutes"
              },
              {
                "value": "30",
                "label": "30 minutes"
              }
            ]
          },
          "one_time_code_private_key": {
            "type": "label",
            "label": "Private key"
          }
        },
        "design": {
          "bgcolor": {
            "type": "selectcolor",
            "label": "Background color",
            "mandatory": 1
          },
          "txtcolor": {
            "type": "selectcolor",
            "label": "Text color",
            "mandatory": 1
          },
          "btncolor": {
            "type": "selectcolor",
            "label": "Button color",
            "mandatory": 1
          },
          "lnktxtcolor": {
            "type": "selectcolor",
            "label": "Link text color",
            "mandatory": 1
          },
          "position": {
            "type": "select",
            "label": "Position",
            "mandatory": 1,
            "options": [
              {
                "value": "bottom-left",
                "label": "Bottom left"
              },
              {
                "value": "bottom-right",
                "label": "Bottom right"
              }
            ]
          },
          "shape": {
            "type": "select",
            "label": "Modules appearance",
            "mandatory": 1,
            "options": [
              {
                "value": "social",
                "label": "Social"
              },
              {
                "value": "fullwidth",
                "label": "Full width"
              }
            ]
          }
        },
        "content": {
          "customized_message": {
            "type": "text",
            "label": "Customized message",
            "mandatory": 1
          },
          "placeholder_text": {
            "type": "text",
            "label": "Insert a message",
            "mandatory": 1
          },
          "destination_url": {
            "type": "text",
            "label": "Destination URL",
            "mandatory": 1
          }
        }
      }
    }
  }
}
Optional parameters
parameterdescription
typescomma separated list of possible types. If not specified the method returns accepted types, otherwise it returns detailed information on the requested types. Types can be ALL to get detailed information on all types
Return values
parameterdescription
dataNA

/ctas/snip

access: [READ]

This method returns the actual snip for CTAs

Example 1 (xml)

Request

https://joturl.com/a/i1/ctas/snip?format=xml&id=123456

Query parameters

format = xml
    id = 123456

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
  </status>  
  <result><[CDATA[<html><head>[...]</head><body>[...]</body></html>]]></result>  
</response>

Example 2 (txt)

Request

https://joturl.com/a/i1/ctas/snip?format=txt&id=123456

Query parameters

format = txt
    id = 123456

Response

status_code=200
status_text=OK
result=[...][...]

Example 3 (plain)

Request

https://joturl.com/a/i1/ctas/snip?format=plain&id=123456

Query parameters

format = plain
    id = 123456

Response

Optional parameters
parameterdescription
idID of the call to action
paramsparameters of the call to action, for a complete list of parameters see the method i1/ctas/property
Return values
parameterdescription
htmlNA

/resources

/resources/add

access: [WRITE]

This method allows to upload a resource

Example 1 (xml)

Request

https://joturl.com/a/i1/resources/add?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
  </status>  
</response>

Example 2 (txt)

Request

https://joturl.com/a/i1/resources/add?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK

Example 3 (plain)

Request

https://joturl.com/a/i1/resources/add?format=plain

Query parameters

format = plain

Response

200
OK
Required parameters
parameterdescription
contextcontext of the upload
inputthe name of the form field used to transfer resource's data
upload_typeType of the upload. Available types: images,ssl
Return values
parameterdescription
idNA
namename of the resource
typetype of the resource
urlcomplete URL of the resource

/resources/count

access: [READ]

This method returns number of resources of a specific upload_type in a context

Example 1 (xml)

Request

https://joturl.com/a/i1/resources/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
  </status>  
  <result>
    <count>754</count>  
  </result>  
</response>

Example 2 (txt)

Request

https://joturl.com/a/i1/resources/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
result_count=754

Example 3 (plain)

Request

https://joturl.com/a/i1/resources/count?format=plain

Query parameters

format = plain

Response

754
Required parameters
parameterdescription
contextcontext of the upload
upload_typeType of the upload. Available types: images,ssl
Return values
parameterdescription
countnumber of resources

/resources/delete

access: [WRITE]

This method deletes a resource

Example 1 (xml)

Request

https://joturl.com/a/i1/resources/delete?format=xml&id=1234567890

Query parameters

format = xml
    id = 1234567890

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
  </status>  
  <result>
    <count>1</count>  
  </result>  
</response>

Example 2 (txt)

Request

https://joturl.com/a/i1/resources/delete?format=txtresource_id=1234567890

Query parameters

format = txtresource_id=1234567890

Response

status_code=200
status_text=OK
result_count=1

Example 3 (plain)

Request

https://joturl.com/a/i1/resources/delete?format=plainresource_id=1234567890

Query parameters

format = plainresource_id=1234567890

Response

1
Required parameters
parameterdescription
contextcontext of the upload
idsIDs of the resources to be deleted
upload_typeType of the upload. Available types: images,ssl
Return values
parameterdescription
countnumber of deleted resources

/resources/edit

access: [WRITE]

This method allows to edit a resource

Example 1 (xml)

Request

https://joturl.com/a/i1/resources/edit?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
  </status>  
</response>

Example 2 (txt)

Request

https://joturl.com/a/i1/resources/edit?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK

Example 3 (plain)

Request

https://joturl.com/a/i1/resources/edit?format=plain

Query parameters

format = plain

Response

200
OK
Required parameters
parameterdescription
contextcontext of the upload
idID of the resource
inputthe name of the form field used to transfer resource's data
upload_typeType of the upload. Available types: images,ssl
Return values
parameterdescription
idNA
namename of the resource
typetype of the resource
urlcomplete URL of the resource

/resources/info

access: [READ]

This method returns information specified in a comma separated input called fields about a resource

Example 1 (xml)

Request

https://joturl.com/a/i1/resources/info?format=xml&id=123456&fields=name,url

Query parameters

format = xml
    id = 123456
fields = name,url

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
  </status>  
  <result>

  </result>  
</response>

Example 2 (txt)

Request

https://joturl.com/a/i1/resources/info?format=txt&iresource_id=123456&fields=name,url

Query parameters

      format = txt
iresource_id = 123456
      fields = name,url

Response

status_code=200
status_text=OK
result=

Example 3 (plain)

Request

https://joturl.com/a/i1/resources/info?format=plain&id=123456&fields=name,url

Query parameters

format = plain
    id = 123456
fields = name,url

Response

Required parameters
parameterdescription
contextcontext of the upload
fieldscomma separated list of resources fields [id,name,url,type,context,date]
idID of the resource
upload_typeType of the upload. Available types: images,ssl
Return values
parameterdescription
dataparameters specified in fields of the resource

/resources/list

access: [READ]

This method returns a list of resource of a specific upload_type in a context

Example 1 (xml)

Request

https://joturl.com/a/i1/resources/list?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
  </status>  
</response>

Example 2 (txt)

Request

https://joturl.com/a/i1/resources/list?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK

Example 3 (plain)

Request

https://joturl.com/a/i1/resources/list?format=plain

Query parameters

format = plain

Response

200
OK
Required parameters
parameterdescription
contextcontext of the upload
fieldscomma separated list of resources fields [id,name,url,type,context,date,count]. You can use the special field count to retrieve the number of resources
upload_typeType of the upload. Available types: images,ssl
Optional parameters
parameterdescription
lengthnumber of items to be extracted
startindex from which the list will be extracted
Return values
parameterdescription
countnumber of resources
dataarray (id,name,url,type) of resources

/urls

/urls/instaurls

/urls/instaurls/edit

access: [WRITE]

Set InstaUrl settings for a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/instaurls/edit?mp_url_id=12345

Query parameters

mp_url_id = 12345

Response

{
  "status": {
    "code": 200,
    "text": "OK"
  },
  "result": []
}
Required parameters
parameterdescription
idNA
settingsNA
Return values
parameterdescription
enabledNA

/urls/instaurls/info

access: [READ]

Get settings for the InstaUrl option.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/instaurls/info?mp_url_id=12345

Query parameters

mp_url_id = 12345

Response

{
  "status": {
    "code": 200,
    "text": "OK"
  },
  "result": []
}
Required parameters
parameterdescription
idNA
Return values
parameterdescription
settingsNA

/urls/instaurls/preview

access: [READ]

Given parameters, this method returns the HTML of an InstaUrl page.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/instaurls/preview?mp_url_id=12345

Query parameters

mp_url_id = 12345

Response

{
  "status": {
    "code": 200,
    "text": "OK"
  },
  "result": []
}
Optional parameters
parameterdescription
settingsNA
Return values
parameterdescription
htmlNA

/urls/instaurls/property

access: [READ]

Returns the list of available properties for the InstaUrl option.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/instaurls/property?mp_url_id=12345

Query parameters

mp_url_id = 12345

Response

{
  "status": {
    "code": 200,
    "text": "OK"
  },
  "result": []
}
Return values
parameterdescription
avatarNA
backgroundNA
cssNA
fontsNA
iconsNA
linksNA
max_itemsNA
messengersNA
social_networksNA
themesNA

/urls/minipages

/urls/minipages/edit

access: [WRITE]

Set a minipage for a tracking link.

Required parameters
parameterdescription
idNA
Optional parameters
parameterdescription
paramsNA
templateNA
template_nameNA
Return values
parameterdescription
addedNA

/urls/minipages/info

access: [READ]

Get the minipage linked to a tracking link.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/minipages/info?id=12345

Query parameters

id = 12345

Response

{
  "status": {
    "code": 200,
    "text": "OK"
  },
  "result": []
}
Required parameters
parameterdescription
idNA
Return values
parameterdescription
dataNA

/urls/minipages/preview

access: [READ]

Given a template and parameters, this method returns the HTML.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/minipages/preview?id=12345

Query parameters

id = 12345

Response

{
  "status": {
    "code": 200,
    "text": "OK"
  },
  "result": []
}
Optional parameters
parameterdescription
idNA
paramsNA
templateNA
template_nameNA
Return values
parameterdescription
htmlNA

/urls/minipages/property

access: [READ]

Returns the list of available minipage templates and their properties.

Example 1 (json)

Request

https://joturl.com/a/i1/urls/minipages/property?id=12345

Query parameters

id = 12345

Response

{
  "status": {
    "code": 200,
    "text": "OK"
  },
  "result": []
}
Return values
parameterdescription
dataNA

/users

/users/brands

/users/brands/add

access: [WRITE]

Add a user brand for the user logged in.

Example 1 (json)

Request

https://joturl.com/a/i1/users/brands/adduser_brand_name=brandname&url_home=http://www.joturl.com

Response

{
  "status": {
    "code": 200,
    "text": "OK"
  },
  "result": {
    "id": "65794b5563376a7a354f6c756b42625946636d2f47773d3d",
    "name": "name"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/brands/add?format=xml&name=brandname&url_home=http://www.joturl.com

Query parameters

  format = xml
    name = brandname
url_home = http://www.joturl.com

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
  </status>  
  <result>
    <id>65794b5563376a7a354f6c756b42625946636d2f47773d3d</id>  
    <name>name</name>  
  </result>  
</response>

Example 3 (plain)

Request

https://joturl.com/a/i1/users/brands/add?format=plain&name=brandname&url_home=http://www.joturl.com

Query parameters

  format = plain
    name = brandname
url_home = http://www.joturl.com

Response

65794b5563376a7a354f6c756b42625946636d2f47773d3d
name
Required parameters
parameterdescription
inputthe name of the form field used to transfer brand's logo
Optional parameters
parameterdescription
namename of the brand
url_homeURL of the brand's home
Return values
parameterdescription
idID of the brand
namename of the brand
urlcomplete URL of the logo image
url_homeURL of the brand's home

/users/brands/count

access: [READ]

This method returns the number of user brand's related to the call to actions

Example 1 (xml)

Request

https://joturl.com/a/i1/users/brands/count?format=xml

Query parameters

format = xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
  </status>  
  <result>
    <count>2805</count>  
  </result>  
</response>

Example 2 (txt)

Request

https://joturl.com/a/i1/users/brands/count?format=txt

Query parameters

format = txt

Response

status_code=200
status_text=OK
result_count=2805

Example 3 (plain)

Request

https://joturl.com/a/i1/users/brands/count?format=plain

Query parameters

format = plain

Response

2805
Optional parameters
parameterdescription
searchfilter items by searching them
Return values
parameterdescription
countnumber of brands

/users/brands/delete

access: [WRITE]

This method deletes a user brand using the ids . Return 1 if the operation succeeds or 0 otherwise

Example 1 (xml)

Request

https://joturl.com/a/i1/users/brands/delete?format=xml&ids=12345abcdef6789,2345abcdef

Query parameters

format = xml
   ids = 12345abcdef6789,2345abcdef

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
  </status>  
  <result>
    <deleted>1</deleted>  
  </result>  
</response>

Example 2 (txt)

Request

https://joturl.com/a/i1/users/brands/delete?format=txt&ids=12345abcdef6789,2345abcdef

Query parameters

format = txt
   ids = 12345abcdef6789,2345abcdef

Response

status_code=200
status_text=OK
result_deleted=1

Example 3 (plain)

Request

https://joturl.com/a/i1/users/brands/delete?format=plain&ids=12345abcdef6789,2345abcdef

Query parameters

format = plain
   ids = 12345abcdef6789,2345abcdef

Response

1
Required parameters
parameterdescription
idsIDs of the brands to be deleted
Return values
parameterdescription
deletednumber of deleted brands

/users/brands/edit

access: [WRITE]

Edit fields of a user brand.

Example 1 (json)

Request

https://joturl.com/a/i1/users/brands/edit?id=123456a&name=newname

Query parameters

  id = 123456a
name = newname

Response

{
  "status": {
    "code": 200,
    "text": "OK"
  },
  "result": {
    "id": "65794b5563376a7a354f6c756b42625946636d2f47773d3d",
    "name": "name"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/users/brands/edit?format=xml&id=123456a&name=newname

Query parameters

format = xml
    id = 123456a
  name = newname

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
  </status>  
  <result>
    <id>65794b5563376a7a354f6c756b42625946636d2f47773d3d</id>  
    <name>name</name>  
  </result>  
</response>

Example 3 (plain)

Request

https://joturl.com/a/i1/users/brands/edit?format=plain&id=123456a&name=newname

Query parameters

format = plain
    id = 123456a
  name = newname

Response

65794b5563376a7a354f6c756b42625946636d2f47773d3d
name
Required parameters
parameterdescription
idID of the brand
Optional parameters
parameterdescription
inputthe name of the form field used to transfer brand's logo
namename of the brand
url_homeURL of the brand's home
Return values
parameterdescription
idID of the brand
namename of the brand
url_homeURL of the brand's home

/users/brands/info

access: [READ]

This method returns information specified in a comma separated input called fields about a user brand

Example 1 (xml)

Request

https://joturl.com/a/i1/users/brands/info?format=xml&id=123456&fields=name,url_home

Query parameters

format = xml
    id = 123456
fields = name,url_home

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
  </status>  
  <result>
    <id>65794b5563376a7a354f6c756b42625946636d2f47773d3d</id>  
    <name>name</name>  
  </result>  
</response>

Example 2 (txt)

Request

https://joturl.com/a/i1/users/brands/info?format=txt&id=123456&fields=name,url_home

Query parameters

format = txt
    id = 123456
fields = name,url_home

Response

status_code=200
status_text=OK
result_id=65794b5563376a7a354f6c756b42625946636d2f47773d3d
result_name=name

Example 3 (plain)

Request

https://joturl.com/a/i1/users/brands/info?format=plain&id=123456&fields=name,url_home

Query parameters

format = plain
    id = 123456
fields = name,url_home

Response

65794b5563376a7a354f6c756b42625946636d2f47773d3d
name
Required parameters
parameterdescription
fieldscomma separated list of fields [id,name,url_home,url,res_id,res_name,context,type,date,count]
Optional parameters
parameterdescription
idID of the brand
res_idNA
Return values
parameterdescription
datarequired fields (id,name,url_home,url,res_id,res_name,context,type,date) of the brand

/users/brands/list

access: [READ]

This method returns a list of user's brands data, specified in a comma separated input called fields.

Example 1 (xml)

Request

https://joturl.com/a/i1/users/brands/list?format=xml&fields=name,url_home

Query parameters

format = xml
fields = name,url_home

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
  </status>  
  <result>
    <item0>
      <id>1a2b3c4d123456</id>  
      <name>brand name</name>  
    </item0>  
    <item1>
      <id>1a2b3c4d123456</id>  
      <name>brand name</name>  
    </item1>  
  </result>  
</response>

Example 2 (txt)

Request

https://joturl.com/a/i1/users/brands/list?format=txt&fields=name,url_home

Query parameters

format = txt
fields = name,url_home

Response

status_code=200
status_text=OK
result_item0_id=1a2b3c4d123456
result_item0_name=brand name
result_item1_id=1a2b3c4d123456
result_item1_name=brand name

Example 3 (plain)

Request

https://joturl.com/a/i1/users/brands/list?format=plain&fields=name,url_home

Query parameters

format = plain
fields = name,url_home

Response

1a2b3c4d123456
brand name
1a2b3c4d123456
brand name
Required parameters
parameterdescription
fieldscomma separated list of fields [id,name,url_home,url,res_id,res_name,context,type,date,count]. You can use the special field count to retrieve the number of resources
Optional parameters
parameterdescription
lengthnumber of items to be extracted
orderbyorder items by one field [id,name,url_home,url,res_id,res_name,context,type,date,count]. Use sort for ascending or descending order. Default is orderby = id
searchfilter items by searching them
sortto be used in conjunction with orderby to select the ascending or descending order [ASC|DESC]. Default is sort = ASC
startindex from which the list will be extracted
Return values
parameterdescription
countnumber of brands
dataarray (id,name,url_home,url,res_id,res_name,context,type,date) of brands

/watchdogs

/watchdogs/add

access: [WRITE]

Given a url identifier, set a watchdog for it.

Example 1 (json)

Request

https://joturl.com/a/i1/watchdogs/add ?&ids=123abcdef&watchdog=1

Query parameters

     ids = 123abcdef
watchdog = 1

Response

{
  "status": {
    "code": 200,
    "text": "OK"
  },
  "result": {
    "updated": "1"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/watchdogs/add?&ids=123abcdef&watchdog=1

Query parameters

     ids = 123abcdef
watchdog = 1

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
  </status>  
  <result>
    <updated>1</updated>  
  </result>  
</response>

Example 3 (plain)

Request

https://joturl.com/a/i1/watchdogs/add?&ids=123abcdef&watchdog=1

Query parameters

     ids = 123abcdef
watchdog = 1

Response

1
Required parameters
parameterdescription
spider_typeNA
watchdogNA
Optional parameters
parameterdescription
idsNA
project_idNA
textNA
text_checkNA
videoNA
watchdogNA
watchdog_set_as_defaultNA
Return values
parameterdescription
updatedNA

/watchdogs/delete

access: [WRITE]

Delete a watchdog related to a given short URL or a given project.

Example 1 (json)

Request

https://joturl.com/a/i1/watchdogs/delete?id=123abcdef

Query parameters

id = 123abcdef

Response

{
  "status": {
    "code": 200,
    "text": "OK"
  },
  "result": {
    "watchdog": "0",
    "spider": "128",
    "spider_check": "0",
    "spider_check_option": "70",
    "spider_only_html": "1",
    "spider_time": "",
    "watchdog_is_default": "0"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/watchdogs/delete?format=xml&id=123abcdef

Query parameters

format = xml
    id = 123abcdef

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
  </status>  
  <result>
    <watchdog>0</watchdog>  
    <spider>128</spider>  
    <spider_check>0</spider_check>  
    <spider_check_option>70</spider_check_option>  
    <spider_only_html>1</spider_only_html>  
    <spider_time></spider_time>  
    <watchdog_is_default>0</watchdog_is_default>  
  </result>  
</response>

Example 3 (plain)

Request

https://joturl.com/a/i1/watchdogs/delete?format=plain&id=123abcdef

Query parameters

format = plain
    id = 123abcdef

Response

0
128
0
70
1

0
Optional parameters
parameterdescription
idNA
project_idNA
Return values
parameterdescription
dataNA

/watchdogs/info

access: [READ]

Returns information on the watchdog related to a given tracking link or a given project.

Example 1 (json)

Request

https://joturl.com/a/i1/watchdogs/info?id=123abcdef

Query parameters

id = 123abcdef

Response

{
  "status": {
    "code": 200,
    "text": "OK"
  },
  "result": {
    "watchdog": "0",
    "spider": "128",
    "spider_check": "0",
    "spider_check_option": "70",
    "spider_only_html": "1",
    "spider_time": "",
    "watchdog_is_default": "0"
  }
}

Example 2 (xml)

Request

https://joturl.com/a/i1/watchdogs/info?format=xml&id=123abcdef

Query parameters

format = xml
    id = 123abcdef

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>  
    <text>OK</text>  
  </status>  
  <result>
    <watchdog>0</watchdog>  
    <spider>128</spider>  
    <spider_check>0</spider_check>  
    <spider_check_option>70</spider_check_option>  
    <spider_only_html>1</spider_only_html>  
    <spider_time></spider_time>  
    <watchdog_is_default>0</watchdog_is_default>  
  </result>  
</response>

Example 3 (plain)

Request

https://joturl.com/a/i1/watchdogs/info?format=plain&id=123abcdef

Query parameters

format = plain
    id = 123abcdef

Response

0
128
0
70
1

0
Optional parameters
parameterdescription
idNA
project_idNA
Return values
parameterdescription
dataNA

/watchdogs/stats

access: [READ]

This method returns stats about a watchdog.

Example 1 (json)

Request

https://joturl.com/a/i1/watchdogs/stats

Response

{
  "status": {
    "code": 200,
    "text": "OK",
    "error": ""
  },
  "result": {
    "stats": "",
    "spiders": ""
  }
}
Return values
parameterdescription
dataNA