v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB

macroManagement

List all macros.

List all viewable macros for the customer.

get/v2/macros

Query parameters

limitinteger

Limit the number of macro returned in the response. The number of macros returned may be less than the limit. Default 50.

tokenstring

Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. token is set to null when no more pages are left.

Response

Paginated list of viewable macros for the customer.

nextstring

Next continuation token. token is set to null when no more pages are left.

Example response

{
  "data": [
    {
      "description": "Macro for geo lookup.",
      "definition": "lookup latitude, longitude from geo://location on ip = {{ip_field}} | count by latitude, longitude | sort _count\"\n",
      "arguments": [
        {
          "name": "ip_field",
          "type": "String"
        }
      ],
      "argumentValidations": [
        {
          "evalExpression": "isValidIp(ip_field)",
          "errorMessage": "You need to enter a field name which is a valid ip."
        }
      ],
      "name": "MacroGeoLookup",
      "macroCreationSuggestionId": "ABC12",
      "id": "C03E086C137F38B4",
      "createdAt": "2024-10-01T09:10:00Z",
      "createdBy": "0000000006743FDD"
    }
  ],
  "next": "GDCiRv4vebF3UWFJQ1kySXBOR3Bzh69GR0RyWm9vCtc"
}