Jump to

• Request
• Response
• Examples

Get http response code analytics as categorical data for rejections, errors, and failures.

get

/apiplatform/analytics/v1/categorical/responses/{statusFilter}

Returns analytics for rejections, errors, and failures as categorical data. Use the statusFilter parameter to specify the type of measures returned.

This operation returns the intersection of all applied query parameter filters.

Any authenticated user can request this resource. The response contains data the requesting user is authorized to view based on their role and the resources they are issued grants to (APIs, applications, and gateways).

Request

Path Parameters

• statusFilter: string
  Pattern: (rejections|errors|failures)

  Filters responses by status. rejections shows HTTP responses of 4*. errors shows HTTP responses of 5*. failures combines rejections and errors.

Query Parameters

• apiIds(optional): array
  Collection Format: multi

  Filter data by apiIds as repeated query parameters (like ?apiIds=2&apiIds=3) or a single-comma separated query parameter (like ?apiIds=2,3).

  • [0]: string

  {
      "in":"query",
      "name":"apiIds",
      "description":"Filter data by apiIds as repeated query parameters (like <code>?apiIds=2&apiIds=3</code>) or a single-comma separated query parameter (like <code>?apiIds=2,3</code>).",
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi",
      "required":false
  }

• appIds(optional): array
  Collection Format: multi

  Filter data by appIds as repeated query parameters (like ?appIds=2&appIds=3) or a single comma separated query parameter (like ?appIds=2,3).

  • [0]: string

  {
      "in":"query",
      "name":"appIds",
      "description":"Filter data by appIds as repeated query parameters (like <code>?appIds=2&appIds=3</code>) or a single comma separated query parameter (like <code>?appIds=2,3</code>).",
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi",
      "required":false
  }

• gatewayIds(optional): array
  Collection Format: multi

  Filter data by gatewayIds as repeated query parameters (like ?gatewayIds=2&gatewayIds=3) or a single-comma separated query parameter (like ?gatewayIds=2,3).

  • [0]: string

  {
      "in":"query",
      "name":"gatewayIds",
      "description":"Filter data by gatewayIds as repeated query parameters (like <code>?gatewayIds=2&gatewayIds=3</code>) or a single-comma separated query parameter (like <code>?gatewayIds=2,3</code>).",
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi",
      "required":false
  }

• groupBys(optional): array
  Collection Format: multi

  Split the query results into groups based on repeated query parameters (like ?groupBys=gatewayIds&groupBys=nodeIds) or a single comma separated query parameter (like ?groupBys=gatewayIds,nodeIds). Both of these examples display query results grouped by available gatewayIds and nodeIds.

  Grouping results by gatewayIds, nodeIds, apiIds, and appIds is supported for all endpoints that support the groupBy query parameter. Additionally, grouping query results by policyVersion, policyType, and policyInstanceId are supported for endpoints with policies in the path.

  • [0]: string

  {
      "in":"query",
      "name":"groupBys",
      "description":"<p>Split the query results into groups based on repeated query parameters (like <code>?groupBys=gatewayIds&groupBys=nodeIds</code>) or a single comma separated query parameter (like <code>?groupBys=gatewayIds,nodeIds</code>). Both of these examples display query results grouped by available gatewayIds and nodeIds.</p><p>Grouping results by <code>gatewayIds</code>, <code>nodeIds</code>, <code>apiIds</code>, and <code>appIds</code> is supported for all endpoints that support the <code>groupBy</code> query parameter. Additionally, grouping query results by <code>policyVersion</code>, <code>policyType</code>, and <code>policyInstanceId</code> are supported for endpoints with <code>policies</code> in the path.</p>",
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi",
      "required":false
  }

• iterations(optional): array
  Collection Format: multi

  Filter data by iterationIds as repeated query parameters (like ?iterationIds=2&iterationIds=3) or a single comma separated query parameter (like ?iterationIds=2,3).

  • [0]: string

  {
      "in":"query",
      "name":"iterations",
      "description":"Filter data by iterationIds as repeated query parameters (like <code>?iterationIds=2&iterationIds=3</code>) or a single comma separated query parameter (like <code>?iterationIds=2,3</code>).",
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi",
      "required":false
  }

• methods(optional): array
  Collection Format: multi

  Filter data by methods as repeated query parameters (like ?methods=GET&methods=PUT) or a single comma separated query parameter (like ?methods=GET,PUT).

  • [0]: string

  {
      "in":"query",
      "name":"methods",
      "description":"Filter data by methods as repeated query parameters (like <code>?methods=GET&methods=PUT</code>) or a single comma separated query parameter (like <code>?methods=GET,PUT</code>).",
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi",
      "required":false
  }

• nodeIds(optional): array
  Collection Format: multi

  Filter data by nodeIds as repeated query parameters (like ?nodeIds=2&appIds=3) or a single comma separated query parameter (like ?nodeIds=2,3).

  • [0]: string

  {
      "in":"query",
      "name":"nodeIds",
      "description":"Filter data by nodeIds as repeated query parameters (like <code>?nodeIds=2&appIds=3</code>) or a single comma separated query parameter (like <code>?nodeIds=2,3</code>).",
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi",
      "required":false
  }

• planIds(optional): array
  Collection Format: multi

  Filter data by planIds as repeated query parameters (like ?planIds=2&planIds=3) or a single comma separated query parameter (like ?planIds=2,3).

  • [0]: string

  {
      "in":"query",
      "name":"planIds",
      "description":"Filter data by planIds as repeated query parameters (like <code>?planIds=2&planIds=3</code>) or a single comma separated query parameter (like <code>?planIds=2,3</code>).",
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi",
      "required":false
  }

• serviceIds(optional): array
  Collection Format: multi

  Filter data by serviceIds as repeated query parameters (like ?serviceIds=2&serviceIds=3) or a single comma separated query parameter (like ?serviceIds=2,3).

  • [0]: string

  {
      "in":"query",
      "name":"serviceIds",
      "description":"Filter data by serviceIds as repeated query parameters (like <code>?serviceIds=2&serviceIds=3</code>) or a single comma separated query parameter (like <code>?serviceIds=2,3</code>).",
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi",
      "required":false
  }

• timeEnd(optional): string
  End time filter as ISO8601 offset date. Example: 2016-01-01T00:00:00-07:00, 2016-01-01T00:00:00Z, 2016-01-01T00:00:00. The default value is no filtering. You must use this in conjunction with the timeSetting=custom query parameter.
• timeOffsetId(optional): string

  ISO8601 time offset ID. Example: Z. This parameter overrides the time offset of timeStart or timeEnd. This parameter is also used when calculating the start of time groups. The value of this parameter defaults to Z. (GMT).

  Note: Best effort is made to apply this parameter, but its accuracy may be limited by existing data granularity.

• timeSetting(optional): string
  Time setting mode. Defaults to custom. Valid values include: custom, currentHour, currentWeek, currentMonth, last15minutes, last60minutes, last24hours, last7days, last30days, last365days, january, february, march, april, may, june, july, august, september, october, november, december, year-2015, year-2016, etc.
• timeStart(optional): string
  Start time filter as ISO8601 offset date. Example: 2016-01-01T00:00:00-07:00, 2016-01-01T00:00:00Z, 2016-01-01T00:00:00. The default value is no filtering. You must use this in conjunction with the timeSetting=custom query parameter.

Back to Top

Response

Supported Media Types

• application/json

200 Response

JSON response with categorical http response data for requests.

Body ()

Collection of http response metrics.

Root Schema : ResponseDistributionCollectionResponse

Type: object

Collection of http response metrics.

Show Source

• count(optional): integer(int32)
  Response item count.
• hasMore(optional): boolean
  Default Value: false

  Indicates if there are more results after the current batch.
• items: array items
  The actual response items.
• limit(optional): integer(int32)
  Paging limit.
• links(optional): array links
  HATEOAS links.
• offset(optional): integer(int32)
  Paging offset.
• states(optional): array states
  An optional list for API states. This is null by default.
• time(optional): object TimeMetadata
  Metadata describing the time parameters used for the database query.

{
    "description":"Collection of http response metrics.",
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "offset":{
            "format":"int32",
            "description":"Paging offset.",
            "type":"integer"
        },
        "count":{
            "format":"int32",
            "description":"Response item count.",
            "type":"integer"
        },
        "limit":{
            "format":"int32",
            "description":"Paging limit.",
            "type":"integer"
        },
        "hasMore":{
            "default":false,
            "description":"Indicates if there are more results after the current batch.",
            "type":"boolean"
        },
        "links":{
            "description":"HATEOAS links.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/GenericLink"
            }
        },
        "time":{
            "description":"Metadata describing the time parameters used for the database query.",
            "$ref":"#/definitions/TimeMetadata"
        },
        "items":{
            "description":"The actual response items.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/A response summary data item."
            }
        },
        "states":{
            "description":"An optional list for API states. This is null by default.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: array

The actual response items.

Show Source

• Array of: object A response summary data item.
  Contains http response code

{
    "description":"The actual response items.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/A response summary data item."
    }
}

Nested Schema : links

Type: array

HATEOAS links.

Show Source

• Array of: object GenericLink
  HATEOAS generic link representation.

{
    "description":"HATEOAS links.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/GenericLink"
    }
}

Nested Schema : states

Type: array

An optional list for API states. This is null by default.

Show Source

• Array of: string

{
    "description":"An optional list for API states. This is null by default.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : TimeMetadata

Type: object

Metadata describing the time parameters used for the database query.

Show Source

• timeEnd(optional): string
  The calculated timeEnd used in the database query.
• timeOffsetId(optional): string
  The calculated timeOffsetId used in the database query.
• timeSetting(optional): string
  Value of the timeSetting query parameter.
• timeStart(optional): string
  The calculated timeStart used in the database query.

{
    "description":"Metadata describing the time parameters used for the database query.",
    "type":"object",
    "properties":{
        "timeEnd":{
            "description":"The calculated <code>timeEnd</code> used in the database query.",
            "type":"string"
        },
        "timeSetting":{
            "description":"Value of the <code>timeSetting</code> query parameter.",
            "type":"string"
        },
        "timeStart":{
            "description":" The calculated <code>timeStart</code> used in the database query.",
            "type":"string"
        },
        "timeOffsetId":{
            "description":"The calculated <code>timeOffsetId</code> used in the database query.",
            "type":"string"
        }
    }
}

Nested Schema : A response summary data item.

Type: object

Contains http response code

Show Source

• api_id(optional): number
  The API's Id.
• api_name(optional): string
  The API's name.
• measure: number
  Value of the measure.
• response_code: string
  The http response code. Example: HTTP 400

{
    "description":"Contains http response code",
    "type":"object",
    "required":[
        "measure",
        "response_code"
    ],
    "properties":{
        "api_id":{
            "description":"The API's Id.",
            "type":"number"
        },
        "response_code":{
            "description":"The http response code. Example: <code>HTTP 400</code>",
            "type":"string"
        },
        "measure":{
            "description":"Value of the measure.",
            "type":"number"
        },
        "api_name":{
            "description":"The API's name.",
            "type":"string"
        }
    }
}

Nested Schema : GenericLink

Type: object

HATEOAS generic link representation.

Show Source

• href: string
  Link reference string.
• method(optional): string
  HTTP method used with the link.
• rel: string
  Link relation string Value is either canonical or a specific string value.
• templated(optional): string
  Allowed Values: [ "true", "false" ]

  Indicates if the link has templated parts.

{
    "description":"HATEOAS generic link representation.",
    "type":"object",
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "templated":{
            "description":"Indicates if the link has templated parts.",
            "type":"string",
            "enum":[
                "true",
                "false"
            ]
        },
        "method":{
            "description":"HTTP method used with the link.",
            "type":"string"
        },
        "rel":{
            "description":"Link relation string Value is either <code>canonical</code> or a specific string value.",
            "type":"string"
        },
        "href":{
            "description":"Link reference string.",
            "type":"string"
        }
    }
}

400 Response

Bad Request

401 Response

Unauthorized

500 Response

Internal Server Error

Back to Top

Examples

The following example shows how to retrieve the total number of failed requests by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X GET 
-H "Authorization: Bearer access_token
https://example.com/apiplatform/analytics/v1/categorical/responses/failures

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Sat, 30 Nov 2017 17:15:41 GMT
Server: Oracle-Traffic-Director/12.2.1.0.0
Content-length: 171
Content-type: application/json
X-oracle-dms-ecid: lN6_M1qdX00000000
X-oracle-dms-rid: 0:1
Via: 1.1 otd_opc
Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0
Transfer-encoding: chunked

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "count": 6,
  "time": {
    "timeEnd": "2017-12-31T00:00:00-07:00",
    "timeSetting": "custom",
    "timeGroupSize": 1,
    "timeStart": "2017-01-01T00:00:00-07:00",
    "timeOffsetId": "-07:00",
    "timeUnit": "MINUTE"
  },
  "items": [
    {
      "response_code": "HTTP 403",
      "measure": 162
    },
    {
      "response_code": "HTTP 401",
      "measure": 59
    },
    {
      "response_code": "HTTP 405",
      "measure": 53
    },
    {
      "response_code": "HTTP 400",
      "measure": 38
    },
    {
      "response_code": "HTTP 500",
      "measure": 27
    },
    {
      "response_code": "HTTP 404",
      "measure": 20
    }
  ]
}

Back to Top