API docs by Redocly

Reporter Service API (1.0)

User Reports Generation Service.

This service provides an API that allows to queue report generation jobs and query for the job state and generated reports' results. When a report job is created through the provided APIs, it is queued until the system has resources to to process the job and create a new report. The state and completion progress of the job can also be queried.

Match Activation Overlap

CRUD Endpoints to manage match-activation overlap reports.

Get all the Match-Activation Overlap reports' job information

Returns a map of all Match-Activation Overlap reports' job information, indexed by the job id.

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Initiate the processing of a new Match-Activation Overlap report

Creates a new job on the system that defines how a new Match-Activation Overlap report should be processed. The job is initially put on a queued state, waiting for system resources to be executed.

If successful, this method returns an object describing the job information pertaining the job that was just created, including its state. The ID of this job is the same as the ID of the report that shall be produced and can be used to further query the API. For example, further requests for updates on the state of the job and the report data itself can be made to /reports/match-activation-overlap/{id} using the ID that is returned from this method.

Request Body schema: application/json

Match-Activation Overlap report job definition.

endDate
string <Local Date>

Local date until when to calculate the report's values

Responses

Request samples

Content type
application/json
{
  • "endDate": "2020-01-01"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "job": {
    }
}

Get a Match-Activation Overlap report job information and report data

Returns an object containing both the job information that originated the queried report, and the report data itself

path Parameters
id
required
number

The id of the Match-Activation Overlap report to retrieve.

Responses

Response samples

Content type
application/json
{
  • "jobInfo": {
    },
  • "report": {
    }
}

Delete a Match-Activation Overlap report job and report data

Deletes the job information that led to the processing of the report and the report data itself. If the report job is still queued or running, it is cancelled.

If the report job exists and is successfuly deleted, the job information that is returned.

path Parameters
id
required
number

The id of the Match-Activation Overlap report to delete.

Responses

Download Match-Activation Overlap report in Excel file format

path Parameters
id
required
number

The id of the Match-Activation Overlap report excel to retrieve.

Responses

Matches

CRUD Endpoints to manage matches reports.

Activations

CRUD Endpoints to manage activations reports.

Get all the Activations reports job information

Returns a map of all Activations reports' job information, indexed by the job id.

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Initiate the processing of a new Activations report

Creates a new job on the system that defines how a new Activations report should be processed. The job is initially put on a queued state, waiting for system resources to be executed.

If successful, this method returns an object describing the job information pertaining the job that was just created, including its state. The ID of this job is the same as the ID of the report that shall be produced and can be used to further query the API. For example, further requests for updates on the state of the job and the report data itself can be made to /reports/activations/{id} using the ID that is returned from this method.

Request Body schema: application/json

Activations report job definition.

startDate
string <Local Date>

Local date from which to calculate the report's values

endDate
string <Local Date>

Local date until when to calculate the report's values

Responses

Request samples

Content type
application/json
{
  • "startDate": "2020-01-01",
  • "endDate": "2020-02-01"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "job": {
    }
}

Get an Activations report job information and report data

Returns an object containing both the job information that originated the queried report, and the report data itself

path Parameters
id
required
number

The id of the Activations report to retrieve.

Responses

Response samples

Content type
application/json
{
  • "jobInfo": {
    },
  • "report": {
    }
}

Delete a Activations report job and report data

Deletes the job information that led to the processing of the report and the report data itself. If the report job is still queued or running, it is cancelled.

If the report job exists and is successfuly deleted, the job information that is returned.

path Parameters
id
required
number

The id of the Activations report to delete.

Responses

Download Activations report in Excel file format

path Parameters
id
required
number

The id of the Activations report to retrieve.

Responses

Attribution

CRUD Endpoints to manage attribution reports.

Get all the Attribution reports job information

Returns a map of all Attribution reports' job information, indexed by the job ID.

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Initiate the processing of a new Attribution report.

Creates a new job on the system that defines how a new Attribution report should be processed. The job is initially put on a queued state, waiting for system resources to be executed.

If successful, this method returns an object describing the job information pertaining the job that was just created, including its state. The ID of this job is the same as the ID of the report that shall be produced and can be used to further query the API. For example, further requests for updates on the state of the job and the report data itself can be made to /reports/attribution/{id} using the ID that is returned from this method.

Request Body schema: application/json

Attribution report job definition

startDate
string <Local Date>

Local date from which to process the attribution report, inclusive

endDate
string <Local Date>

Local date until which to process the attribution report, inclusive

object (AttributionEventFilterAndExtractor)

Object that holds the definitions to filter conversion events and where to extract the value from when processing the report.

Responses

Request samples

Content type
application/json
{
  • "startDate": "2020-01-01",
  • "endDate": "2020-02-01",
  • "conversionEventFilter": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "job": {
    }
}

Get an Attribution report job information and report data.

Returns an object containing both the job information that originated the queried report, and the report data itself.

path Parameters
id
required
string (UUID)
Example: 0d6a792b-25df-491c-ab60-9239e8985e9b

The ID of the Attribution report to retrieve.

Responses

Response samples

Content type
application/json
{
  • "jobInfo": {
    },
  • "report": {
    }
}

Delete an Attribution report job and its data.

Deletes the job information that led to the processing of the report and the report data itself. If the job is still queued or running, it is cancelled.

If the report job exists and is successfully deleted, the job information is returned.

path Parameters
id
required
string

The ID of the Attribution report to delete.

Responses

Usage

CRUD Endpoints to manage usage reports.

Get all the Usage Reports

Returns a list of all available Usage reports.

Responses

Response samples

Content type
application/json
[
  • {
    }
]