Skip to main content
GET
/
v1
/
marketInsights
cURL
curl --request GET \
  --url https://api.statista.ai/v1/marketInsights \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "identifier": 123,
      "title": "<string>",
      "link": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "platform": "de",
      "path": [
        {
          "name": "<string>",
          "id": 123
        }
      ],
      "geolocations": [
        {
          "name": "<string>",
          "code": "<string>",
          "id": 123
        }
      ],
      "description": "<string>",
      "sub_title": "<string>",
      "children": [
        {
          "name": "<string>",
          "id": 123
        }
      ]
    }
  ],
  "total_count": 123,
  "total_pages": 123
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
q
string
default:*

The query string to search for content. Defaults to '*' which means all content.

​
platform
enum<string>

The platform to search for content. Defaults to en which means English.

Available options:
de,
en,
fr,
es
​
offset
integer<uint32>
default:0

The number of items will be skipped before the first result. The default value for offset is 0. This is useful for pagination. Could be used in combination with size.

Required range: x >= 0
​
size
integer<uint32>
default:10

The max. value depends on which API Package you are using. The default value for size is 10. See API-Packages for more information.

An alias for size is limit

Required range: x >= 0
​
page
integer<uint32>
default:1

The page number to return. The default value for page is 1. This is useful for pagination. Could be used in combination with size.

Required range: x >= 1
​
date_from
string<date-time>

The start date to search for content. All content published after this date will be returned. We accept a variety of date formats, e.g. YYYY-MM-DD. For example, 2023-01-01 will return all content published after or on the January 1st, 2023. If not set, we will use 3 months into the past as the default value. The maximum search depth is limited to 20 years from today while the default is 3 months from today. Supported formats are

  • RFC 33939 (%Y-%m-%dT%H:%M:%S like in ISO 8601)
  • %Y-%m-%d %H:%M:%S - example 2024-03-07 12:45:38
  • %d.%m.%Y %H:%M:%S - example 03.07.2024 12:45:38
  • %Y/%m/%d %H:%M:%S - example 2024/03/07 12:45:38
  • %Y-%m-%d - example 2024-03-07 (in this case we assume 00:00:00 as time for Start and 23:59:59 for End)
  • %d.%m.%Y - example 03.07.2024 (in this case we assume 00:00:00 as time for Start and 23:59:59 for End)
  • %Y/%m/%d - example 2024/03/07 (in this case we assume 00:00:00 as time for Start and 23:59:59 for End)
​
date_to
string<date-time>

The end date to search for content. All content published before this date will be returned. We accept a variety of date formats, e.g. YYYY-MM-DD. For example, 2023-01-01 will return all content published before or on the January 1st, 2023. If not set, the current date is used. Supported formats are

  • RFC 33939 (%Y-%m-%dT%H:%M:%S like in ISO 8601)
  • %Y-%m-%d %H:%M:%S - example 2024-03-07 12:45:38
  • %d.%m.%Y %H:%M:%S - example 03.07.2024 12:45:38
  • %Y/%m/%d %H:%M:%S - example 2024/03/07 12:45:38
  • %Y-%m-%d - example 2024-03-07 (in this case we assume 00:00:00 as time for Start and 23:59:59 for End)
  • %d.%m.%Y - example 03.07.2024 (in this case we assume 00:00:00 as time for Start and 23:59:59 for End)
  • %Y/%m/%d - example 2024/03/07 (in this case we assume 00:00:00 as time for Start and 23:59:59 for End)
​
geolocation
object

Filters content based on a specific geographic location. Defaults to Worldwide which means all content. Use geolocation codes provided by the API documentation. For example, 1 for Worldwide, 2 for Africa, etc. Note: only one geolocation can be used at a time.

​
sort
enum<number>
default:0

Choose how you want the results to be ordered: 0 – Best match first (sorted by relevance) 1 – Most recent first (sorted by publication date) Defaults to 0.

Available options:
0,
1

Response

The request has succeeded.

​
items
object[]
required

A list of results returned for the current request.

​
total_count
integer<uint32>
required

The total number of available items matching the request.

​
total_pages
integer<uint32>

The total number of pages available, based on the selected size parameter