Infographics

GET /v1/infographics

cURL

cURL

curl --request GET \
  --url https://api.statista.ai/v1/infographics \
  --header 'x-api-key: <api-key>'

200

{
  "items": [
    {
      "identifier": 123,
      "title": "<string>",
      "link": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "platform": "de",
      "subject": "<string>",
      "is_premium": true,
      "description": "<string>",
      "industries": [
        {
          "name": "<string>",
          "id": 123
        }
      ],
      "teaser_image_urls": [
        {
          "width": 123,
          "src": "<string>"
        }
      ]
    }
  ],
  "total_count": 123,
  "total_pages": 123
}

Authorizations

x-api-key · string · header · required

Query Parameters

q · string

The query string to search for content. If omitted or empty/whitespace-only, the API uses a broad default query.

platform · enum<string>

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

Available options: de, en, en-de

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)

sort · enum<number>

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

Available options: 0, 1

Response

200

application/json

The request has succeeded.

items · object[] · required

A list of results returned for the current request.

Show child attributes

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