LeadsLeads Report

Leads Report

Aggregate lead performance metrics.

curl -X GET "https://api.nexus.usehardal.com/analytics/leads/?timeframe=today&startDate=example_string&endDate=example_string&timezone=example_string&isCompareEnabled=false&compareStartDate=example_string&compareEndDate=example_string&aggregationBy=example_string&targetSignalId=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_KEY"
{}
GET
/analytics/leads/
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
timeframestring

Preset timeframe. Use custom with startDate and endDate, or omit when startDate/endDate are provided.

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

Start date (YYYY-MM-DD)

query
endDatestring

End date (YYYY-MM-DD)

query
timezonestring

Timezone for date filtering (default: Europe/Istanbul)

query
isCompareEnabledstring

Enable comparison range calculations (default: false)

query
compareStartDatestring

Comparison start date (YYYY-MM-DD)

query
compareEndDatestring

Comparison end date (YYYY-MM-DD)

query
aggregationBystring

Aggregation fields (comma-separated or repeated): lead_id,country,city,district,type,category,label,name

query
targetSignalIdstring

Target signal ID for an authorized mobile app or related signal in the same project

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

timeframestring

Preset timeframe. Use custom with startDate and endDate, or omit when startDate/endDate are provided.

Allowed values:todayyesterdaylast7dayslast30dayscustom
startDatestring

Start date (YYYY-MM-DD)

endDatestring

End date (YYYY-MM-DD)

timezonestring

Timezone for date filtering (default: Europe/Istanbul)

isCompareEnabledstring

Enable comparison range calculations (default: false)

compareStartDatestring

Comparison start date (YYYY-MM-DD)

compareEndDatestring

Comparison end date (YYYY-MM-DD)

aggregationBystring

Aggregation fields (comma-separated or repeated): lead_id,country,city,district,type,category,label,name

targetSignalIdstring

Target signal ID for an authorized mobile app or related signal in the same project

Responses

200 response