ListDatasets

GET/analytics/v1/dashboard/datasets

Response Body

200application/json

Success

type: unknown

{
  "$ref": "#/components/schemas/analytics.v1.ListDatasetsResponse",
  "$ref-value": {
    "type": "object",
    "properties": {
      "datasets": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/analytics.v1.Dataset",
          "$ref-value": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "examples": [
                  "content_views"
                ],
                "title": "id"
              },
              "label": {
                "type": "string",
                "examples": [
                  "Content views"
                ],
                "title": "label"
              },
              "metrics": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/analytics.v1.DatasetMetric",
                  "$ref-value": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string",
                        "examples": [
                          "unique_users"
                        ],
                        "title": "name"
                      },
                      "label": {
                        "type": "string",
                        "examples": [
                          "Unique users"
                        ],
                        "title": "label"
                      },
                      "aggregation": {
                        "type": "string",
                        "examples": [
                          "count_distinct"
                        ],
                        "title": "aggregation"
                      }
                    },
                    "title": "DatasetMetric",
                    "additionalProperties": false
                  }
                },
                "title": "metrics"
              },
              "dimensions": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/analytics.v1.DatasetField",
                  "$ref-value": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string",
                        "examples": [
                          "country"
                        ],
                        "title": "name"
                      },
                      "label": {
                        "type": "string",
                        "examples": [
                          "Country"
                        ],
                        "title": "label"
                      },
                      "type": {
                        "type": "string",
                        "examples": [
                          "string"
                        ],
                        "title": "type"
                      }
                    },
                    "title": "DatasetField",
                    "additionalProperties": false
                  }
                },
                "title": "dimensions"
              },
              "filters": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/analytics.v1.DatasetField",
                  "$ref-value": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string",
                        "examples": [
                          "country"
                        ],
                        "title": "name"
                      },
                      "label": {
                        "type": "string",
                        "examples": [
                          "Country"
                        ],
                        "title": "label"
                      },
                      "type": {
                        "type": "string",
                        "examples": [
                          "string"
                        ],
                        "title": "type"
                      }
                    },
                    "title": "DatasetField",
                    "additionalProperties": false
                  }
                },
                "title": "filters"
              }
            },
            "title": "Dataset",
            "additionalProperties": false
          }
        },
        "title": "datasets"
      }
    },
    "title": "ListDatasetsResponse",
    "additionalProperties": false
  }
}
curl -X GET "https://api.rixl.com/analytics/v1/dashboard/datasets"

Success

application/json

{
  "$ref": "#/components/schemas/analytics.v1.ListDatasetsResponse",
  "$ref-value": {
    "type": "object",
    "properties": {
      "datasets": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/analytics.v1.Dataset",
          "$ref-value": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "examples": [
                  "content_views"
                ],
                "title": "id"
              },
              "label": {
                "type": "string",
                "examples": [
                  "Content views"
                ],
                "title": "label"
              },
              "metrics": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/analytics.v1.DatasetMetric",
                  "$ref-value": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string",
                        "examples": [
                          "unique_users"
                        ],
                        "title": "name"
                      },
                      "label": {
                        "type": "string",
                        "examples": [
                          "Unique users"
                        ],
                        "title": "label"
                      },
                      "aggregation": {
                        "type": "string",
                        "examples": [
                          "count_distinct"
                        ],
                        "title": "aggregation"
                      }
                    },
                    "title": "DatasetMetric",
                    "additionalProperties": false
                  }
                },
                "title": "metrics"
              },
              "dimensions": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/analytics.v1.DatasetField",
                  "$ref-value": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string",
                        "examples": [
                          "country"
                        ],
                        "title": "name"
                      },
                      "label": {
                        "type": "string",
                        "examples": [
                          "Country"
                        ],
                        "title": "label"
                      },
                      "type": {
                        "type": "string",
                        "examples": [
                          "string"
                        ],
                        "title": "type"
                      }
                    },
                    "title": "DatasetField",
                    "additionalProperties": false
                  }
                },
                "title": "dimensions"
              },
              "filters": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/analytics.v1.DatasetField",
                  "$ref-value": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string",
                        "examples": [
                          "country"
                        ],
                        "title": "name"
                      },
                      "label": {
                        "type": "string",
                        "examples": [
                          "Country"
                        ],
                        "title": "label"
                      },
                      "type": {
                        "type": "string",
                        "examples": [
                          "string"
                        ],
                        "title": "type"
                      }
                    },
                    "title": "DatasetField",
                    "additionalProperties": false
                  }
                },
                "title": "filters"
              }
            },
            "title": "Dataset",
            "additionalProperties": false
          }
        },
        "title": "datasets"
      }
    },
    "title": "ListDatasetsResponse",
    "additionalProperties": false
  }
}