Skip to main content

signaloid-cli users logs

View account activity logs.

Synopsis​

signaloid-cli users logs [options]

Options​

OptionDescription
--from <iso>Filter from timestamp (ISO 8601)
--to <iso>Filter to timestamp (ISO 8601)
--cursor <cursor>Resume a listing from the Cursor value of the previous output, with the same filters
--count <n>Number of items to fetch, across pages. The output's Cursor resumes after the last one.
--limit <n>Items per request, at most 10000 (default 100)

Description​

The users logs command retrieves activity logs for your account. Without --from, the command returns entries from the last 7 days.

Each entry in the logs array contains the following fields:

  • eventType
  • eventResponse
  • userName
  • ipAddress
  • deviceName
  • city
  • country

The response also contains queryTimeRange, the time window of the query, and totalResults, the number of entries.

Note

An empty result does not mean that your account was inactive. Not every API or CLI request creates a log entry.

Examples​

View recent activity:

signaloid-cli users logs --count 20

View activity for specific date range:

signaloid-cli users logs \
  --from 2025-01-01T00:00:00Z \
  --to 2025-01-31T23:59:59Z

Filter by event type:

signaloid-cli users logs --count 100 | \
  jq -r --arg type "<event type>" '.logs[] | select(.eventType == $type) | "\(.ipAddress)\t\(.city)\t\(.country)"'

List the locations of account activity:

#!/bin/bash
# Check for activity from unexpected locations

signaloid-cli users logs --count 50 | \
  jq -r '.logs[] | "\(.ipAddress)\t\(.city)\t\(.country)"' | \
  sort | uniq -c | sort -rn

Daily activity summary:

#!/bin/bash
# Daily activity summary

echo "Activity for $(date -d 'yesterday' +%Y-%m-%d):"

FROM=$(date -d 'yesterday' -u +"%Y-%m-%dT00:00:00Z")
TO=$(date -d 'yesterday' -u +"%Y-%m-%dT23:59:59Z")

signaloid-cli users logs --from $FROM --to $TO | \
  jq -r '.logs[] | .eventType' | \
  sort | uniq -c | sort -rn

Notes​

  • Timestamps must be in ISO 8601 format (e.g., 2025-01-13T12:00:00Z).
  • Log retention period depends on your account plan.
  • Results are returned in reverse chronological order (most recent first).
  • The JSON output has logs, queryTimeRange and totalResults, the number of entries printed. When more entries are available, it also has Cursor, which continues with older entries. See Pagination.
  • Output is always JSON. --format is still accepted, so scripts that pass it keep working, but it has no effect.

Troubleshooting​

Empty Logs​

Problem: No activity logs returned.

Solutions:

  1. Expand date range using --from and --to options. Without --from, the command covers only the last 7 days.
  2. Increase --count. Without it, the command fetches only one page, 100 entries by default.
  3. Check if account is newly created
  4. Verify authentication status

Invalid Date Format​

Problem: Error about invalid timestamp format.

Solutions:

  1. Use ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
  2. Ensure timestamps are in UTC (ending with Z)
  3. Example: 2025-01-13T12:00:00Z

"Not authenticated" Error​

Problem: Command fails with authentication error.

Solutions:

  1. Login first: signaloid-cli auth login
  2. Verify authentication: signaloid-cli auth whoami
  3. Check API key is valid

See Also​

Last updated on