EventsEvent Fields

Event Fields

List available event columns and event data fields with sample values.

curl -X GET "https://api.nexus.usehardal.com/analytics/events/fields?timezone=example_string&eventName=John%20Doe&targetSignalId=example_string&sampleSize=example_string&limit=example_string&offset=example_string&interval=minute&selectedEvents=%5B%22example_string%22%5D&notSelectedEvents=%5B%22example_string%22%5D&timeframe=today&startDate=example_string&endDate=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_KEY"
{}
GET
/analytics/events/fields
GET
Base URLstring

Target server for requests. Edit to use your own host.

API Key (header: Authorization)
Authorizationstring
Required

API key (sent in header)

query
timezonestring

Timezone for date filtering (default: Europe/Istanbul)

query
eventNamestring

Filter metrics by a specific event name

query
targetSignalIdstring

Target signal ID for comparison

query
sampleSizestring

Number of event samples to return (default: 1, max: 5)

query
limitstring

Number of records to return for raw events (default: 20, max: 1000)

Min: 1 • Max: 1000
query
offsetstring

Number of records to skip for raw events pagination (default: 0, max: 10000)

Min: 0 • Max: 10000
query
intervalstring

Interval for time series aggregation (minute, hour, day, week, month)

Options: minute, hour, day, week, month
query
timeframestring

Timeframe for the query

Options: today, yesterday, last7days, last30days, custom
query
startDatestring

Start date (YYYY-MM-DD)

query
endDatestring

End date (YYYY-MM-DD)

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

API Key for authentication. Provide your API key in the header.

Query Parameters

timezonestring

Timezone for date filtering (default: Europe/Istanbul)

eventNamestring

Filter metrics by a specific event name

targetSignalIdstring

Target signal ID for comparison

sampleSizestring

Number of event samples to return (default: 1, max: 5)

limitstring

Number of records to return for raw events (default: 20, max: 1000)

offsetstring

Number of records to skip for raw events pagination (default: 0, max: 10000)

intervalstring

Interval for time series aggregation (minute, hour, day, week, month)

Allowed values:minutehourdayweekmonth
timeframestring

Timeframe for the query

Allowed values:todayyesterdaylast7dayslast30dayscustom
startDatestring

Start date (YYYY-MM-DD)

endDatestring

End date (YYYY-MM-DD)

Responses

200 response