Generate Report

Generate a report based on filter selections (such as search term, shelfpageids, retailerids, columns/report).

Url Parameters

• companyid – Your company id.

Body

• searchtermids - List of search term ids [optional].

• shelfpageids - List of shelf page ids [optional].

• productids – List of product ids [optional].

• productlistids - List of product list ids, will override any productids provided [optional].

• retailerids - List of retailer ids [optional].

• pageoneonly - Only consider page one results for search terms. Only applicable if searchtermids are provided ("true" or "false". The default is "true".).

• startdate - Required.

• enddate - The default is the same date as startdate [optional].

• columnids - ids of report columns (as provided by GET api/report/insights/v2/{companyid}/columns) [required].

  Note:

  May also include private attribute GUIDs for data enrichment with PIM values.

• format - csv (default) or xlsx are supported [optional].

• maxrowsperfile - Maximum number of rows per file (excluding header row). If exceeding report will be split into more files. If this option is specified each filename will have suffix (before file extension) "Part N of M". [optional].

Sample Request

POST /api/report/insights/v2/{companyid}/reports

{
  "searchtermids": [
    "2e02a2c3-3242-4a0f-a002-093a319fde6c",
    "c38aa66f-f664-4cb5-9448-687ab75a5db5"
  ],
  "productids": [
    "09c2f876-84f5-4eb9-85d0-b6fa1c2934bb"
  ],
  "startdate": "2021-04-01",
  "enddate": "2021-04-30",
  "columnids": {
    "product": [
      "crawldate",
      "productname"
    ]
  },
  "pageoneonly": true,
  "format": "csv",
  "maxrowsperfile": 10000
}

Sample Response

HTTP 200 Accepted
Location: https://api.syndigo.com/api/report/insights/v2/reports/status/<reportid>
{
"report_id": "<reportid>"
}