Create site time range targeting

Creates a time range targeting rule for the specified site.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/site/{siteId}/targeting/time-range/create.do

Creates a time range targeting rule for the specified site. The rule matches ad requests occurring within the specified time window (24-hour format). If clientLocalTime is true, the time check uses the visitor's local timezone; otherwise UTC is used. Returns the created targeting rule on success. Requires TIME_RANGE targeting permission.

Path Params

siteId integer required

Unique numeric ID of the site

3001

Form Params

rule string required

Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist

INCLUDE

timeFrom string required

Start time in 24-hour format hh:MM (e.g. 09:00)

09:00

timeTo string required

End time in 24-hour format hh:MM (e.g. 18:30)

18:30

clientLocalTime boolean

If true, check time in visitor's local timezone; otherwise use UTC (defaults to false)

false

Responses

200

Success

400

Invalid targeting value

401

Unauthorized

403

Forbidden

404

Site not found

500

Internal server error

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/site/3001/targeting/time-range/create.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'rule=INCLUDE' \
  --data-urlencode 'timeFrom=09:00' \
  --data-urlencode 'timeTo=18:30' \
  --data-urlencode 'clientLocalTime=false'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/site/3001/targeting/time-range/create.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"rule": "INCLUDE", "timeFrom": "09:00", "timeTo": "18:30", "clientLocalTime": "false"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/site/3001/targeting/time-range/create.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"rule":"INCLUDE","timeFrom":"09:00","timeTo":"18:30","clientLocalTime":"false"}),
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/site/3001/targeting/time-range/create.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("rule=INCLUDE&timeFrom=09%3A00&timeTo=18%3A30&clientLocalTime=false"))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("POST"), "https://YOUR-NETWORK-DOMAIN/rest-api/site/3001/targeting/time-range/create.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["rule"] = "INCLUDE", ["timeFrom"] = "09:00", ["timeTo"] = "18:30", ["clientLocalTime"] = "false" });

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	req, _ := http.NewRequest("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/site/3001/targeting/time-range/create.do", strings.NewReader(`rule=INCLUDE&timeFrom=09%3A00&timeTo=18%3A30&clientLocalTime=false`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/site/3001/targeting/time-range/create.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'rule=INCLUDE&timeFrom=09%3A00&timeTo=18%3A30&clientLocalTime=false');

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/site/3001/targeting/time-range/create.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('rule' => "INCLUDE", 'timeFrom' => "09:00", 'timeTo' => "18:30", 'clientLocalTime' => "false")

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body