GetTopImages

GET/analytics/v1/top/images

Query Parameters

limit?limit

The limit query parameter.

Formatint32
range.start?start

The range.start query parameter.

range.end?end

The range.end query parameter.

Response Body

200application/json

Success

type: unknown

{
  "$ref": "#/components/schemas/analytics.v1.TopImagesResponse",
  "$ref-value": {
    "type": "object",
    "properties": {
      "images": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/analytics.v1.ImageStats",
          "$ref-value": {
            "type": "object",
            "properties": {
              "image_id": {
                "type": "string",
                "examples": [
                  "FpzVPNx1cG"
                ],
                "title": "image_id"
              },
              "total_views": {
                "type": "string",
                "examples": [
                  "1250"
                ],
                "title": "total_views",
                "format": "int64"
              },
              "unique_viewers": {
                "type": "string",
                "examples": [
                  "1250"
                ],
                "title": "unique_viewers",
                "format": "int64"
              },
              "avg_view_duration_ms": {
                "type": "number",
                "examples": [
                  "0.85"
                ],
                "title": "avg_view_duration_ms",
                "format": "double",
                "description": "Dwell time; images have no playback."
              },
              "total_view_duration_ms": {
                "type": "number",
                "examples": [
                  "0.85"
                ],
                "title": "total_view_duration_ms",
                "format": "double"
              },
              "feed_views": {
                "type": "string",
                "examples": [
                  "1250"
                ],
                "title": "feed_views",
                "format": "int64"
              },
              "standalone_views": {
                "type": "string",
                "examples": [
                  "1250"
                ],
                "title": "standalone_views",
                "format": "int64"
              }
            },
            "title": "ImageStats",
            "additionalProperties": false
          }
        },
        "title": "images"
      }
    },
    "title": "TopImagesResponse",
    "additionalProperties": false
  }
}
curl -X GET "https://api.rixl.com/analytics/v1/top/images"

Success

application/json

{
  "$ref": "#/components/schemas/analytics.v1.TopImagesResponse",
  "$ref-value": {
    "type": "object",
    "properties": {
      "images": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/analytics.v1.ImageStats",
          "$ref-value": {
            "type": "object",
            "properties": {
              "image_id": {
                "type": "string",
                "examples": [
                  "FpzVPNx1cG"
                ],
                "title": "image_id"
              },
              "total_views": {
                "type": "string",
                "examples": [
                  "1250"
                ],
                "title": "total_views",
                "format": "int64"
              },
              "unique_viewers": {
                "type": "string",
                "examples": [
                  "1250"
                ],
                "title": "unique_viewers",
                "format": "int64"
              },
              "avg_view_duration_ms": {
                "type": "number",
                "examples": [
                  "0.85"
                ],
                "title": "avg_view_duration_ms",
                "format": "double",
                "description": "Dwell time; images have no playback."
              },
              "total_view_duration_ms": {
                "type": "number",
                "examples": [
                  "0.85"
                ],
                "title": "total_view_duration_ms",
                "format": "double"
              },
              "feed_views": {
                "type": "string",
                "examples": [
                  "1250"
                ],
                "title": "feed_views",
                "format": "int64"
              },
              "standalone_views": {
                "type": "string",
                "examples": [
                  "1250"
                ],
                "title": "standalone_views",
                "format": "int64"
              }
            },
            "title": "ImageStats",
            "additionalProperties": false
          }
        },
        "title": "images"
      }
    },
    "title": "TopImagesResponse",
    "additionalProperties": false
  }
}