API Documentation

API Documentation

Create jobs, poll status, and fetch long-running reports.

API Introduction Back to top

Overview

This API collects long-running reports through a job-based workflow. Requests move through three stages:

  1. Create a report request
  2. Poll for completed status
  3. Fetch the report
Host: reporting.lycos.com Protocol: http

Authentication Back to top

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"

Fetching Requests Back to top

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"
  }
}

Field Validation Back to top

  • alpha
    Alphabet characters only, no special characters
  • alphanumeric
    Alpha Numeric String
  • bool
    Boolean value 1 or 0
  • date
    Date in yyyy-mmm-dd
  • datetime
    Date in yyyy-mmm-dd hh:mm:ss.ssssss
  • int
    Number
  • string
    String of characters

Reports Back to top

Each report accepts the arguments below. Use the example request URL as a starting point.

Tags listing

Lists all tags associated with the partner
Example request
Report formats
csv
Required arguments Required

None

Optional arguments Optional

None

Support Back to top

Contact us for support