/ai/activity/users - Content Ignite

GET

/

v1

/

ai

/

activity

/

users

/ai/activity/users

curl --request GET \
  --url https://api.tagdeliver.com/v1/ai/activity/users \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.tagdeliver.com/v1/ai/activity/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tagdeliver.com/v1/ai/activity/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.tagdeliver.com/v1/ai/activity/users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.tagdeliver.com/v1/ai/activity/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "results": [
    {
      "user_id": 1001,
      "user_name": "Alex",
      "email": "alex@example.com",
      "full_name": "Alex Example"
    }
  ],
  "success": true
}

{
  "success": false,
  "message": "User forbidden"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

range

enum<string>

default:thirty_days

Date range to report on. Preset ranges end yesterday and today is today so far. month_to_date is the current month so far and week_to_date is the current week so far. custom requires start and end (YYYY-MM-DD). Other values return a 400 error

Available options:

custom,

all_time,

today,

seven_days,

fourteen_days,

thirty_days,

three_months,

six_months,

week_to_date,

month_to_date,

quarter_to_date,

year_to_date,

last_week,

last_month,

last_quarter,

last_year,

month_on_month,

quarter_on_quarter,

yesterday

start

string<date>

Start date when range=custom

end

string<date>

End date when range=custom

exclude_internal

enum<string>

default:0

Set to 1 to leave out internal organisations

Available options:

0,

1

Response

results

object[]

required

Users with Spark or summary activity in the period, by display name

Show child attributes

success

boolean

required

⌘I

/ai/activity/users

curl --request GET \
  --url https://api.tagdeliver.com/v1/ai/activity/users \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.tagdeliver.com/v1/ai/activity/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tagdeliver.com/v1/ai/activity/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.tagdeliver.com/v1/ai/activity/users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.tagdeliver.com/v1/ai/activity/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "results": [
    {
      "user_id": 1001,
      "user_name": "Alex",
      "email": "alex@example.com",
      "full_name": "Alex Example"
    }
  ],
  "success": true
}

{
  "success": false,
  "message": "User forbidden"
}