Profile Event Activity

❗️stream/query is currently in maintenance mode.

This endpoint returns the activity feed for specified users.

Note: The Query API has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.

GET /stream/query

Profile Event Activity

cURL

curl --request GET \
  --url https://{regionAndDomain}.com/api/query/stream/query \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://{regionAndDomain}.com/api/query/stream/query"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://{regionAndDomain}.com/api/query/stream/query', 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://{regionAndDomain}.com/api/query/stream/query",
  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: Basic <encoded-value>"
  ],
]);

$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://{regionAndDomain}.com/api/query/stream/query"

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

	req.Header.Add("Authorization", "Basic <encoded-value>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{regionAndDomain}.com/api/query/stream/query")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{regionAndDomain}.com/api/query/stream/query")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

200

{
  "status": "ok",
  "results": {
    "events": [
      {
        "event": "Game Played",
        "properties": {
          "time": 1599589453,
          "$distinct_id": "12a34aa567eb8d-9ab1c26f345b67-89123c45-6aeaa7-89f12af345f678",
          "$browser": "Chrome",
          "$city": "Austin",
          "$region": "Texas",
          "report_name": "insights"
        }
      },
      {
        "event": "Viewed Page",
        "properties": {
          "time": 1599589470,
          "distinct_id": "12a34aa567eb8d-9ab1c26f345b67-89123c45-6aeaa7-89f12af345f678",
          "$browser": "Chrome",
          "$city": "Austin",
          "$region": "Texas",
          "report_name": "funnels"
        }
      }
    ]
  }
}

Authorizations

ServiceAccountProjectSecret

Authorization · string · header · required

Service Account

Query Parameters

project_id · integer · required

Required if using service account to authenticate request.

workspace_id · integer

The id of the workspace if applicable.

distinct_ids · string · required

A JSON array as a string representing the distinct_ids to return activity feeds for. For example: ["12a34aa567eb8d-9ab1c26f345b67-89123c45-6aeaa7-89f12af345f678"]

from_date · string · required

The date in yyyy-mm-dd format to begin querying from. This date is inclusive.

to_date · string · required

The date in yyyy-mm-dd format to query to. This date is inclusive.

Response

200 - application/json

Success.

status · string

results · object

Show child attributes