Rybbit
APIStats

Users

Retrieve user-level analytics data including user lists, sessions, and profiles

See the API Reference for authentication, common parameters, and filters.

Endpoints

GET/api/users/:siteGET/api/users/:userId/sessions/:siteGET/api/users/session-count/:siteGET/api/users/:userId/:site

Get Users

GET /api/users/:site

Returns a paginated list of users with their analytics data. Supports filtering by identified users only.

Path Parameters

Prop

Type

Query Parameters

Accepts all Common Parameters plus the following:

Prop

Type

Response

Prop

Type

User Object

Prop

Type

Request
curl -X GET "https://api.rybbit.io/api/users/123?page=1&page_size=10&sort_by=last_seen&sort_order=desc" \
  -H "Authorization: Bearer your_api_key_here"
Request
const response = await fetch(
  'https://api.rybbit.io/api/users/123?page=1&page_size=10&sort_by=last_seen&sort_order=desc',
  {
    headers: {
      'Authorization': 'Bearer your_api_key_here'
    }
  }
);

const data = await response.json();
Request
import requests

response = requests.get(
    'https://api.rybbit.io/api/users/123',
    params={
        'page': 1,
        'page_size': 10,
        'sort_by': 'last_seen',
        'sort_order': 'desc'
    },
    headers={
        'Authorization': 'Bearer your_api_key_here'
    }
)

data = response.json()
Request
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/users/123?page=1&page_size=10&sort_by=last_seen&sort_order=desc');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer your_api_key_here'
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
Request
require 'net/http'
require 'json'

uri = URI('https://api.rybbit.io/api/users/123?page=1&page_size=10&sort_by=last_seen&sort_order=desc')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
Request
req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/users/123?page=1&page_size=10&sort_by=last_seen&sort_order=desc", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")

client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

var data map[string]interface{}
json.NewDecoder(resp.Body).Decode(&data)
Request
let client = reqwest::Client::new();
let res = client
    .get("https://api.rybbit.io/api/users/123?page=1&page_size=10&sort_by=last_seen&sort_order=desc")
    .header("Authorization", "Bearer your_api_key_here")
    .send()
    .await?;

let data: serde_json::Value = res.json().await?;
Request
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.rybbit.io/api/users/123?page=1&page_size=10&sort_by=last_seen&sort_order=desc"))
    .header("Authorization", "Bearer your_api_key_here")
    .GET()
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
Request
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");

var response = await client.GetAsync("https://api.rybbit.io/api/users/123?page=1&page_size=10&sort_by=last_seen&sort_order=desc");
var data = await response.Content.ReadAsStringAsync();
Response
{
  "data": [
    {
      "user_id": "abc123def456",
      "identified_user_id": "user@example.com",
      "traits": {
        "plan": "pro",
        "company": "Acme Inc"
      },
      "country": "US",
      "region": "California",
      "city": "San Francisco",
      "language": "en-US",
      "browser": "Chrome",
      "operating_system": "macOS",
      "device_type": "desktop",
      "pageviews": 156,
      "events": 23,
      "sessions": 12,
      "hostname": "example.com",
      "first_seen": "2024-01-15T10:30:00.000Z",
      "last_seen": "2024-01-31T14:22:00.000Z"
    }
  ],
  "totalCount": 1247,
  "page": 1,
  "pageSize": 10
}

Get User Session Count

GET /api/users/session-count/:site

Returns the number of sessions per day for a specific user. Useful for visualizing user engagement over time.

Path Parameters

Prop

Type

Query Parameters

Prop

Type

Response

Prop

Type

DailyCount Object

Prop

Type

Request
curl -X GET "https://api.rybbit.io/api/users/session-count/123?user_id=abc123def456&time_zone=America/New_York" \
  -H "Authorization: Bearer your_api_key_here"
Request
const response = await fetch(
  'https://api.rybbit.io/api/users/session-count/123?user_id=abc123def456&time_zone=America/New_York',
  {
    headers: {
      'Authorization': 'Bearer your_api_key_here'
    }
  }
);

const data = await response.json();
Request
import requests

response = requests.get(
    'https://api.rybbit.io/api/users/session-count/123',
    params={
        'user_id': 'abc123def456',
        'time_zone': 'America/New_York'
    },
    headers={
        'Authorization': 'Bearer your_api_key_here'
    }
)

data = response.json()
Request
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/users/session-count/123?user_id=abc123def456&time_zone=America/New_York');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer your_api_key_here'
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
Request
require 'net/http'
require 'json'

uri = URI('https://api.rybbit.io/api/users/session-count/123?user_id=abc123def456&time_zone=America/New_York')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
Request
req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/users/session-count/123?user_id=abc123def456&time_zone=America/New_York", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")

client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

var data map[string]interface{}
json.NewDecoder(resp.Body).Decode(&data)
Request
let client = reqwest::Client::new();
let res = client
    .get("https://api.rybbit.io/api/users/session-count/123?user_id=abc123def456&time_zone=America/New_York")
    .header("Authorization", "Bearer your_api_key_here")
    .send()
    .await?;

let data: serde_json::Value = res.json().await?;
Request
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.rybbit.io/api/users/session-count/123?user_id=abc123def456&time_zone=America/New_York"))
    .header("Authorization", "Bearer your_api_key_here")
    .GET()
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
Request
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");

var response = await client.GetAsync("https://api.rybbit.io/api/users/session-count/123?user_id=abc123def456&time_zone=America/New_York");
var data = await response.Content.ReadAsStringAsync();
Response
{
  "data": [
    {
      "date": "2024-01-15",
      "sessions": 2
    },
    {
      "date": "2024-01-18",
      "sessions": 1
    },
    {
      "date": "2024-01-22",
      "sessions": 3
    },
    {
      "date": "2024-01-31",
      "sessions": 1
    }
  ]
}

Get User Info

GET /api/users/:userId/:site

Returns detailed information about a specific user, including their profile traits and linked devices.

Path Parameters

Prop

Type

Response

Prop

Type

UserInfo Object

Prop

Type

LinkedDevice Object

Prop

Type

Request
curl -X GET "https://api.rybbit.io/api/users/user@example.com/123" \
  -H "Authorization: Bearer your_api_key_here"
Request
const response = await fetch(
  'https://api.rybbit.io/api/users/user@example.com/123',
  {
    headers: {
      'Authorization': 'Bearer your_api_key_here'
    }
  }
);

const data = await response.json();
Request
import requests

response = requests.get(
    'https://api.rybbit.io/api/users/user@example.com/123',
    headers={
        'Authorization': 'Bearer your_api_key_here'
    }
)

data = response.json()
Request
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/users/user@example.com/123');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer your_api_key_here'
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
Request
require 'net/http'
require 'json'

uri = URI('https://api.rybbit.io/api/users/user@example.com/123')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
Request
req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/users/user@example.com/123", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")

client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

var data map[string]interface{}
json.NewDecoder(resp.Body).Decode(&data)
Request
let client = reqwest::Client::new();
let res = client
    .get("https://api.rybbit.io/api/users/user@example.com/123")
    .header("Authorization", "Bearer your_api_key_here")
    .send()
    .await?;

let data: serde_json::Value = res.json().await?;
Request
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.rybbit.io/api/users/user@example.com/123"))
    .header("Authorization", "Bearer your_api_key_here")
    .GET()
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
Request
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");

var response = await client.GetAsync("https://api.rybbit.io/api/users/user@example.com/123");
var data = await response.Content.ReadAsStringAsync();
Response
{
  "data": {
    "user_id": "abc123def456",
    "identified_user_id": "user@example.com",
    "traits": {
      "name": "John Doe",
      "plan": "pro",
      "company": "Acme Inc"
    },
    "sessions": 12,
    "pageviews": 156,
    "events": 23,
    "duration": 245,
    "country": "US",
    "region": "California",
    "city": "San Francisco",
    "language": "en-US",
    "browser": "Chrome",
    "browser_version": "120.0.0",
    "operating_system": "macOS",
    "operating_system_version": "14.2",
    "device_type": "desktop",
    "screen_width": 2560,
    "screen_height": 1440,
    "first_seen": "2024-01-15T10:30:00.000Z",
    "last_seen": "2024-01-31T14:22:00.000Z",
    "linked_devices": [
      {
        "anonymous_id": "xyz789ghi012",
        "created_at": "2024-01-20T08:15:00.000Z"
      }
    ]
  }
}

Events

Retrieve event data including custom events, pageviews, and outbound links

Goals

Create and track conversion goals based on page visits or custom events