GetFilterOptions

POST/analytics/v1/dashboard/filter-options

Request Body

required

application/json

{
  "$ref": "#/components/schemas/analytics.v1.GetFilterOptionsRequest",
  "$ref-value": {
    "type": "object",
    "properties": {
      "dataset": {
        "type": "string",
        "examples": [
          "content_views"
        ],
        "title": "dataset"
      },
      "field": {
        "type": "string",
        "examples": [
          "country"
        ],
        "title": "field"
      },
      "time_start": {
        "type": "string",
        "examples": [
          "2026-01-15T10:30:00Z"
        ],
        "title": "time_start"
      },
      "time_end": {
        "type": "string",
        "examples": [
          "2026-01-15T10:30:00Z"
        ],
        "title": "time_end"
      },
      "limit": {
        "type": "integer",
        "examples": [
          "50"
        ],
        "title": "limit",
        "format": "int32"
      },
      "search": {
        "type": "string",
        "examples": [
          "united"
        ],
        "title": "search",
        "maxLength": 100
      }
    },
    "title": "GetFilterOptionsRequest",
    "required": [
      "dataset",
      "field"
    ],
    "additionalProperties": false
  }
}

Response Body

200application/json

Success

type: unknown

{
  "$ref": "#/components/schemas/analytics.v1.GetFilterOptionsResponse",
  "$ref-value": {
    "type": "object",
    "properties": {
      "options": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/analytics.v1.FilterOption",
          "$ref-value": {
            "type": "object",
            "properties": {
              "value": {
                "type": "string",
                "examples": [
                  "US"
                ],
                "title": "value"
              },
              "count": {
                "type": "string",
                "examples": [
                  "1250"
                ],
                "title": "count",
                "format": "int64"
              }
            },
            "title": "FilterOption",
            "additionalProperties": false
          }
        },
        "title": "options"
      }
    },
    "title": "GetFilterOptionsResponse",
    "additionalProperties": false
  }
}

curl -X POST "https://api.rixl.com/analytics/v1/dashboard/filter-options" \
  -H "Content-Type: application/json" \
  -d '{
    "dataset": "content_views",
    "field": "country"
  }'

Success

application/json

{
  "$ref": "#/components/schemas/analytics.v1.GetFilterOptionsResponse",
  "$ref-value": {
    "type": "object",
    "properties": {
      "options": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/analytics.v1.FilterOption",
          "$ref-value": {
            "type": "object",
            "properties": {
              "value": {
                "type": "string",
                "examples": [
                  "US"
                ],
                "title": "value"
              },
              "count": {
                "type": "string",
                "examples": [
                  "1250"
                ],
                "title": "count",
                "format": "int64"
              }
            },
            "title": "FilterOption",
            "additionalProperties": false
          }
        },
        "title": "options"
      }
    },
    "title": "GetFilterOptionsResponse",
    "additionalProperties": false
  }
}