API Documentation
Create jobs, poll status, and fetch long-running reports.
Overview
This API collects long-running reports through a job-based workflow. Requests move through three stages:
- Create a report request
- Poll for completed status
- Fetch the report
Host: reporting.lycos.com
Protocol: http
HTTP Basic Authentication
The API uses HTTP Basic authentication on protected endpoints.
Building the credentials string
Example
basic_auth_string = base64(username + ":" + password)
Making an authenticated request
Example
curl
curl -X GET -H "Authorization: Basic c3R1ZGVudDpzdHVkZW50" "reporting.lycos.com/examplerequest"
Use these endpoints to create a job, check its status, and download the finished report. See the Reports section for report-specific arguments.
Create a report request
Example request
GET
GET /create/{$REPORT_NAME}/?args=foo&more=bar
Example response
{
"code": 200,
"message": "Created",
"payload": {
"jobid": 1,
"report": "$REPORT_NAME",
"created": "2020-06-28T17:28:22.678069073Z",
"completed": "0001-01-01T00:00:00Z"
}
}
Check report status
Example request
GET
GET /status/{$JOBID}
Example response
{
"code": 200,
"message": "Complete",
"payload": {
"jobid": 1,
"report": "csvtest",
"created": "2020-06-28T17:28:22.678069073Z",
"completed": "2020-06-28T17:28:23.121288136Z"
}
}
Fetch a report
Example request
GET
GET /fetch/{$JOBID}
Not ready response
{
"code": 204,
"message": "In-Progress",
"payload": {
"jobid": 12,
"report": "csvtest",
"message": "Job is not complete",
"created": "2020-06-28T17:28:22.678069073Z",
"completed": "0001-01-01T00:00:00Z"
}
}
Invalid response
{
"code": 500,
"message": "Invalid Job",
"payload": {
"jobid": 0,
"report": "",
"message": "Job ID Not Found",
"created": "0001-01-01T00:00:00Z",
"completed": "0001-01-01T00:00:00Z"
}
}
Each report accepts the arguments below. Use the example request URL as a starting point.
Beacon Performance
Beacon Performance report returns information about beacon performance
Example request
Report formats
csv
Required arguments Required
| Field |
Type |
Default |
date_end |
date |
2025-06-11 |
date_start |
date |
2025-06-10 |
Optional arguments Optional
None
List of Clicks
Provides a list of clicks, impression IDs and status
Example request
Report formats
csv
Required arguments Required
| Field |
Type |
Default |
date_end |
date |
— |
date_start |
date |
— |
Optional arguments Optional
| Field |
Type |
Default |
mkt |
alpha |
% |
Source Tag Device Data Report
Lists source tag with device data for partner
Example request
Report formats
csv
Required arguments Required
| Field |
Type |
Default |
date_end |
date |
— |
date_start |
date |
— |
Optional arguments Optional
| Field |
Type |
Default |
mkt |
alpha |
— |
Hourly Device Level Report
Lists device level data by hour
Example request
Report formats
csv
Required arguments Required
| Field |
Type |
Default |
date_end |
date |
— |
date_start |
date |
— |
hour |
int |
1 |
Optional arguments Optional
| Field |
Type |
Default |
mkt |
alpha |
— |
Device Type Tag Report
Lists type tags by device
Example request
Report formats
csv
Required arguments Required
| Field |
Type |
Default |
date_end |
date |
— |
date_start |
date |
— |
Optional arguments Optional
| Field |
Type |
Default |
mkt |
alpha |
— |
Device Type Tag Report with CTR
Lists type tags by device
Example request
Report formats
csv
Required arguments Required
| Field |
Type |
Default |
date_end |
date |
— |
date_start |
date |
— |
Optional arguments Optional
| Field |
Type |
Default |
mkt |
alpha |
— |
Hourly Device Level Report
Lists device level data by hour
Example request
Report formats
csv
Required arguments Required
| Field |
Type |
Default |
date_end |
date |
— |
date_start |
date |
— |
hour |
int |
0 |
Optional arguments Optional
| Field |
Type |
Default |
hour_end |
int |
— |
mkt |
alpha |
— |
Hourly Device Level Report with CTR
Lists device level data by hour with CTR field precalculated
Example request
Report formats
csv
Required arguments Required
| Field |
Type |
Default |
date_end |
date |
— |
date_start |
date |
— |
hour |
int |
0 |
Optional arguments Optional
| Field |
Type |
Default |
hour_end |
int |
— |
mkt |
alpha |
— |
Partner TQ Report
Provides partner TQ for a period of time, broken down by device
Example request
Report formats
csv
Required arguments Required
| Field |
Type |
Default |
date_end |
date |
— |
date_start |
date |
— |
Optional arguments Optional
None
Source Data Report
Lists source data for partner
Example request
Report formats
csv
Required arguments Required
| Field |
Type |
Default |
date_end |
date |
— |
date_start |
date |
— |
Optional arguments Optional
| Field |
Type |
Default |
mkt |
alpha |
— |
Daily Source Data Report
Daily data at the source tag level. all gives all devices, '' ignores devices
Example request
Report formats
csv
Required arguments Required
| Field |
Type |
Default |
date_end |
date |
— |
date_start |
date |
— |
Optional arguments Optional
| Field |
Type |
Default |
device |
alpha |
— |
mkt |
alpha |
— |
Hourly Source Data Report
Hourly data at the source tag level. all gives all devices, '' ignores devices
Example request
Report formats
csv
Required arguments Required
| Field |
Type |
Default |
date_end |
date |
— |
date_start |
date |
— |
hour |
int |
0 |
Optional arguments Optional
| Field |
Type |
Default |
device |
alpha |
— |
hour_end |
int |
— |
mkt |
alpha |
— |
Source Report Hourly
Lists source tag data by hour
Example request
Report formats
csv
Required arguments Required
| Field |
Type |
Default |
date_end |
date |
— |
date_start |
date |
— |
hour |
int |
1 |
Optional arguments Optional
| Field |
Type |
Default |
hour_end |
int |
— |
mkt |
alpha |
— |
Source Type Data Report
Lists source tag with type tags data for partner
Example request
Report formats
csv
Required arguments Required
| Field |
Type |
Default |
date_end |
date |
— |
date_start |
date |
— |
Optional arguments Optional
| Field |
Type |
Default |
mkt |
alpha |
— |
Source Type Hourly Data Report
Lists source tag with type tags data for partner
Example request
Report formats
csv
Required arguments Required
| Field |
Type |
Default |
date_end |
date |
— |
date_start |
date |
— |
hour |
int |
1 |
Optional arguments Optional
| Field |
Type |
Default |
hour_end |
int |
— |
mkt |
alpha |
— |
Tags listing
Lists all tags associated with the partner
Example request
Report formats
csv
Required arguments Required
None
Optional arguments Optional
None
Daily Type Tag Data Report
Daily data at the type tag level. all gives all devices, '' ignores devices
Example request
Report formats
csv
Required arguments Required
| Field |
Type |
Default |
date_end |
date |
— |
date_start |
date |
— |
Optional arguments Optional
| Field |
Type |
Default |
device |
alpha |
— |
mkt |
alpha |
— |
Hourly Type Data Report
Hourly data at the type tag level. all gives all devices, '' ignores devices
Example request
Report formats
csv
Required arguments Required
| Field |
Type |
Default |
date_end |
date |
— |
date_start |
date |
— |
hour |
int |
0 |
Optional arguments Optional
| Field |
Type |
Default |
device |
alpha |
— |
hour_end |
int |
— |
mkt |
alpha |
— |