Query Cellular Metrics Top N (v2.0)

Query all the cellular metrics Topn N.

application/json

Request Body

Filter for top N

• end_time date required

  The end time to get the Topn N reports. The time period for the Topn N reports is usually for week.

• filter object required

  Details of the filter used in this query.

• name string required

  The name of the Top N report. Maz size = 128.

• start_time date required

  The start time to get the Topn N reports. The time period for the Topn N reports is usually for week.

• top_n BaseTopNView required

  The details of the limit and type of the Top N reports.

  limit integer required

  The query limit of the Top N reports. Should be between 1 and 10.

  type string required

  The type of Top N reports.

• topn_basis string required

  The basis of the Top N reports.

Responses

• 200
• 400

---

Successful Operation

application/json

• Schema
• Example (from schema)

---

Schema

• top_n BaseTopNResponseData required

  The details of the Top N reports.

  end_time string required

  The end time to get the Topn N reports. The time period for the Topn N reports is usually a week.

  items string[] required

  The items in the query.

  limit integer required

  The details of the limit and type of the Top N reports.

  start_time string required

  The start time to get the Topn N reports. The time period for the Topn N reports is usually a week.

  topn_basis string required

  The basis of the Top N reports.

  type string required

  The type of Top N report.

{
  "top_n": {
    "end_time": "string",
    "items": [
      "string"
    ],
    "limit": 0,
    "start_time": "string",
    "topn_basis": "string",
    "type": "string"
  }
}

Bad Request

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• _error ErrorResponse[]

  Array [

  code string

  message string

  ]

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

{
  "value": {
    "_error": [
      {
        "code": "INVALID_REQUEST_ERROR_0001"
      },
      {
        "code": "APP_FILTER_NOT_SUPPORTED_FOR_TYPE"
      },
      {
        "code": "SITE_FILTER_NOT_SUPPORTED_FOR_TYPE"
      },
      {
        "code": "FILTER_NOT_SUPPORTED_WITHOUT_SITE"
      },
      {
        "code": "START_TIME_GREATER_THAN_END_TIME"
      },
      {
        "code": "PATH_NOT_SUPPORTED_WITH_PATH_TYPE"
      },
      {
        "code": "TOPN_BASIS_NOT_SUPPORTED_WITHOUT_FILTER"
      },
      {
        "code": "INVALID_LIMIT"
      },
      {
        "code": "TOPN_BASIS_REQUIRED"
      },
      {
        "code": "TOP_N_REQUIRED"
      },
      {
        "code": "TOPN_TYPE_REQUIRED"
      },
      {
        "code": "PATH_TYPE_LIST_LENGTH_EXCEEDED"
      },
      {
        "code": "FILTER_NOT_SUPPORTED"
      }
    ]
  }
}

Loading...