Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 33 Current »

In this section we can see an updated list of every available reports, their descriptions, their required input parameters and the expected output for their newer implementation in the V2:

List of available reports:

URI Parameters

Parameter name

Type

Required

Description

start_dateint(tick)start of date interval* (ISO 8601 format) - UTC
end_dateint(tick)end of date interval* (ISO 8601 format) - UTC
filterslist[str](error)list of filter names to be applied separated by comma
filter_nlist[str](tick)for each filter on filters, its values separated by comma
formatstr(error)output format regarding the response, it can be either 'json' or 'csv'. The value by default is 'json'.

* Note that when we are doing a filter by two dates we got records greater than or equal than the start_date and less than the end_date. For example if we want to get records from the 3rd of May to the 15th of May (both included) we need to send start_date=2017-05-03T00:00:00.000Z and end_date=2017-05-16T00:00:00.000Z.

Report IDs

Example request for Opportunities Report

filterslang=escategory=woman

report_paramsmax_items=10order=desc

{base_url}/analysis/{site_id}/OpportunitiesReport?start_date=0&end_date=20&filters=lang,category,scope&lang=es&category=woman&scope=default&rows=10
  • No labels