CampaignCampaign Report

Campaign Report

Analyze campaign performance. Returns aggregated attribution data along with time series data for charting; the time series shape is controlled by the interval, breakdown, and metric query parameters. When comparison is enabled (isCompareEnabled=true with compareStartDate and compareEndDate), the response also includes a compareTimeSeries array containing the same time series shape for the comparison period so charts can plot both ranges together.

curl -X GET "https://api.nexus.usehardal.com/analytics/campaign/?timeframe=today&startDate=example_string&endDate=example_string&isHybrid=example_string&timezone=example_string&isCompareEnabled=false&compareStartDate=example_string&compareEndDate=example_string&targetSignalId=example_string&interval=hour&breakdown=source&metric=sessions" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_KEY"
{}
GET
/analytics/campaign/
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
isHybridstring

Use hybrid/self-hosted query endpoint (true/false)

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
targetSignalIdstring

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

query
intervalstring

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

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

Breakdown level for time series chart. Default: source

Options: source, medium, campaign
query
metricstring

Metric to display on time series chart. Default: sessions

Options: sessions, conversions
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)

isHybridstring

Use hybrid/self-hosted query endpoint (true/false)

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)

targetSignalIdstring

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

intervalstring

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

Allowed values:minutehourdayweekmonth
breakdownstring

Breakdown level for time series chart. Default: source

Allowed values:sourcemediumcampaign
metricstring

Metric to display on time series chart. Default: sessions

Allowed values:sessionsconversions

Responses

200 response