Sarv.com

NODEJS

Choose Language

Tracking Domains Calls

Info! This is Beta version, if you have any problem in using API, please mail us at support@sarv.com

/settings/addTrackingDomain

Add a new Tracking Domains

Example Call

            
var sarv = require('./sarv.js');
var sarv_client = new sarv.Sarv('owner_id', 'token', 'SarvTES_APP_DOMAIN');
sarv_client.settings.addTrackingDomain({domain:"abc.com"}, function(result) {
    console.log(result);
    /*
    {
        "status" : "success",
        "message" : "Tracking Domain Added"
    }
     */
    
}, function(e) {
    // Sarv returns the error as an object with name and message keys
    console.log('A sarv error occurred: ' + e.name + ' - ' + e.message);
});

Example Success Response


{
    "status" : "success",
    "message" : "Tracking Domain Added"
}

Example Error Response


{
    "status"=> "error",
    "code"=> -1,
    "name"=> "AuthenticationError",
    "message"=> "Token MissMatch"
}
Parameters
owner_id* string a valid Sarv User Id
token* string a valid token
SarvTES_APP_DOMAIN* string a valid SarvTES APP DOMAIN
domain* string domain name
* compulsory field
Return Value: Success
struct the results of newly Added Domain
status string always success
message string human readable message
Return Value: Error
struct the error results when attempt to add domain
status string error
message string human readable message
type string one of the error type as bellow table
Error types
ValidationError The parameters passed to the API call are invalid or not provided when required.
GeneralError An unexpected errors occurred processing the request. Sarv Developers will be notified.
AuthenticationError Provided owner_id and token was not matched.

/settings/checkTrackingDomain

check Tracking Domain

Example Call

            
var sarv = require('./sarv.js');
var sarv_client = new sarv.Sarv('owner_id', 'token', 'SarvTES_APP_DOMAIN');
sarv_client.settings.checkTrackingDomain({domain:"abc.com"}, function(result) {
    console.log(result);
    /*
    {
        "status" : "success",
        "domain" : "abc.com",
        "valid_tracking" : "Yes",
        "cname" : {"valid" : "Yes"}
    }
     */
    
}, function(e) {
    // Sarv returns the error as an object with name and message keys
    console.log('A sarv error occurred: ' + e.name + ' - ' + e.message);
});

Example Success Response


{
    "status" : "success",
    "domain" : "abc.com",
    "valid_tracking" : "Yes",
    "cname" : {"valid" : "Yes"}
}

Example Error Response


{
    "status"=> "error",
    "code"=> -1,
    "name"=> "AuthenticationError",
    "message"=> "Token MissMatch"
}
Parameters
owner_id* string a valid Sarv User Id
token* string a valid token
SarvTES_APP_DOMAIN* string a valid SarvTES APP DOMAIN
domain* string domain name
* compulsory field
Return Value: Success
struct the results of check Tracking Domain
status string always success
message string human readable message
valid_tracking string value is Either 'Yes' OR 'No'
cname[]struct cname validation result
valid string value is either 'Yes' OR 'No'
Return Value: Error
struct the error results when attempt check Tracking Domain
status string error
message string human readable message
type string one of the error type as bellow table
Error types
ValidationError The parameters passed to the API call are invalid or not provided when required.
GeneralError An unexpected errors occurred processing the request. Sarv Developers will be notified.
AuthenticationError Provided owner_id and token was not matched.

/settings/listTrackingDomain

List Tracking Domain

Example Call

            
var sarv = require('./sarv.js');
var sarv_client = new sarv.Sarv('owner_id', 'token', 'SarvTES_APP_DOMAIN');
sarv_client.settings.listTrackingDomain({}, function(result) {
    console.log(result);
    /*
    {
        "status" : "success",
        "tracking_domain_list" :   [
                                        {
                                            "domain":"abc.com",
                                            "create_date":67457775764,
                                            "cname":{"valid" : "Yes"}
                                        },
                                        {
                                            "domain":"xyz.com",
                                            "create_date":67457775891,
                                            "cname":{"valid" : "Yes"}
                                        }
                                    ]
    }
     */
    
}, function(e) {
    // Sarv returns the error as an object with name and message keys
    console.log('A sarv error occurred: ' + e.name + ' - ' + e.message);
});

Example Success Response


{
    "status" : "success",
    "tracking_domain_list"  :   [
                                    {
                                        "domain":"abc.com",
                                        "create_date":67457775764,
                                        "cname":{"valid" : "Yes"}
                                    },
                                    {
                                        "domain":"xyz.com",
                                        "create_date":67457775891,
                                        "cname":{"valid" : "Yes"}
                                    }
                                ]
}

Example Error Response


{
    "status"=> "error",
    "code"=> -1,
    "name"=> "AuthenticationError",
    "message"=> "Token MissMatch"
}
Parameters
owner_id* string a valid Sarv User Id
token* string a valid token
SarvTES_APP_DOMAIN* string a valid SarvTES APP DOMAIN
* compulsory field
Return Value: Success
struct the results of List Tracking Domain
status string always success
message string human readable message
tracking_domain_list[]struct information of single Tracking Domain
domain string domain name
create_date integer create date in micro seconds
cname[]struct cname validation result
valid string value is Either 'Yes' OR 'No'
Return Value: Error
struct the error results when attempt to List Tracking Domain
status string error
message string human readable message
type string one of the error type as bellow table
Error types
ValidationError The parameters passed to the API call are invalid or not provided when required.
GeneralError An unexpected errors occurred processing the request. Sarv Developers will be notified.
AuthenticationError Provided owner_id and token was not matched.

/settings/deleteTrackingDomain

Delete Tracking Domain

Example Call

            
var sarv = require('./sarv.js');
var sarv_client = new sarv.Sarv('owner_id', 'token', 'SarvTES_APP_DOMAIN');
sarv_client.settings.deleteTrackingDomain({domain:"abc.com"}, function(result) {
    console.log(result);
    /*
    {
        "status" : "success",
        "message" : "Tracking Domain Deleted"
    }
     */
    
}, function(e) {
    // Sarv returns the error as an object with name and message keys
    console.log('A sarv error occurred: ' + e.name + ' - ' + e.message);
});

Example Success Response


{
    "status" : "success",
    "message" : "Tracking Domain Deleted"
}

Example Error Response


{
    "status"=> "error",
    "code"=> -1,
    "name"=> "AuthenticationError",
    "message"=> "Token MissMatch"
}
Parameters
owner_id* string a valid Sarv User Id
token* string a valid token
SarvTES_APP_DOMAIN* string a valid SarvTES APP DOMAIN
domain* string domain name
* compulsory field
Return Value: Success
struct the results of Delete Tracking domain
status string always success
message string human readable message
Return Value: Error
struct the error results when attempt to Delete Tracking Domain
status string error
message string human readable message
type string one of the error type as bellow table
Error types
ValidationError The parameters passed to the API call are invalid or not provided when required.
GeneralError An unexpected errors occurred processing the request. Sarv Developers will be notified.
AuthenticationError Provided owner_id and token was not matched.