Retrieve a list of insight types

Insight types are generalized categories that encompass various specific occurrences of the same kind.

GET /waap/v1/security-insights/types

Try it

Python

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
page = client.waap.insights.list_types()
page = page.results[0]
print(page.description)

200

{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "results": [
    {
      "name": "<string>",
      "description": "<string>",
      "slug": "<string>",
      "labels": [
        "<string>"
      ],
      "insight_template": "<string>",
      "recommendation_template": "<string>",
      "insight_grouping_dimensions": [
        "<string>"
      ],
      "insight_frequency": 123
    }
  ]
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Query Parameters

ordering · enum<string> · default: name

Sort the response by given field.

Available options: name, -name, slug, -slug, insight_frequency, -insight_frequency

limit · integer · default: 100

Number of items to return

Required range: 0 <= x <= 100

offset · integer · default: 0

Number of items to skip

Required range: 0 <= x <= 100000

name · string | null

Filter by the name of the insight type

slug · string | null

Filter by the slug of the insight type

insight_frequency · integer | null

Filter by the frequency of the insight type

Required range: x > 0

Response

200

application/json

Successful Response

limit · integer · required

Number of items requested in the response

offset · integer · required

Items response offset used

count · integer · required

Number of items contain in the response

results · InsightType · object[] · required

List of items returned in the response following given criteria

Show child attributes

results. name · string · required

The name of the insight type

results. description · string · required

The description of the insight type

results. slug · string · required

The slug of the insight type

results. labels · string[] · required

The labels of the insight type

results. insight_template · string · required

The insight template

results. recommendation_template · string · required

The recommendation template

results. insight_grouping_dimensions · string[] · required

The grouping dimensions of the insight type

results. insight_frequency · integer · required

The frequency of the insight type