Analytics of API Key.

curl --request GET \
  --url https://{tenant}/api/activity/keys/{keyHash}/{startDay}/{startMonth}/{startYear}/{EndDay}/{EndMonth}/{EndYear} \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "error": 4,
      "hits": 31,
      "id": {
        "alias": "",
        "api_id": "41351a6a94094da05f75146a695a16f6",
        "api_name": "Keyless",
        "code": 404,
        "day": 0,
        "hour": 0,
        "iso_country": "",
        "key": "",
        "month": 0,
        "path": "/anything",
        "url": "",
        "year": 0
      },
      "last_hit": "2024-06-19T07:11:39Z",
      "latency": 0,
      "max_latency": 0,
      "max_upstream_latency": 0,
      "min_latency": 0,
      "min_upstream_latency": 0,
      "request_time": 174.5,
      "success": 27,
      "upstream_latency": 0
    }
  ],
  "pages": 1
}

GET

api

activity

keys

{keyHash}

{startDay}

{startMonth}

{startYear}

{EndDay}

{EndMonth}

{EndYear}

Analytics of API Key.

curl --request GET \
  --url https://{tenant}/api/activity/keys/{keyHash}/{startDay}/{startMonth}/{startYear}/{EndDay}/{EndMonth}/{EndYear} \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "error": 4,
      "hits": 31,
      "id": {
        "alias": "",
        "api_id": "41351a6a94094da05f75146a695a16f6",
        "api_name": "Keyless",
        "code": 404,
        "day": 0,
        "hour": 0,
        "iso_country": "",
        "key": "",
        "month": 0,
        "path": "/anything",
        "url": "",
        "year": 0
      },
      "last_hit": "2024-06-19T07:11:39Z",
      "latency": 0,
      "max_latency": 0,
      "max_upstream_latency": 0,
      "min_latency": 0,
      "min_upstream_latency": 0,
      "request_time": 174.5,
      "success": 27,
      "upstream_latency": 0
    }
  ],
  "pages": 1
}

Authorizations

Authorization

string

header

required

The Tyk Dashboard API Access Credentials

Path Parameters

startDay

string

required

Day to start querying the analytics from.

startMonth

string

required

Month to start querying the analytics from.

startYear

string

required

Year to start querying the analytics from.

EndDay

string

required

End date of analytics to query.

EndMonth

string

required

End month of analytics to query.

EndYear

string

required

End year of analytics to query.

keyHash

string

required

Hash of your API key.

Response

Returns analytics of all endpoints called using the given key between the given time range.

data

object[] | null

Show child attributes

data.error

integer

Example:

4

data.hits

integer

Example:

26

data.id

object

Show child attributes

data.id.alias

string

data.id.api_id

string

Example:

"7364617cc7d345d9755d182635dfd46d"

data.id.api_name

string

Example:

"OAS http"

data.id.code

integer

data.id.day

integer

Example:

12

data.id.hour

integer

Example:

0

data.id.iso_country

string

data.id.key

string

data.id.month

integer

Example:

6

data.id.path

string

data.id.queries

object

Show child attributes

data.id.queries.{key}

integer

data.id.url

string

data.id.year

integer

Example:

2024

data.last_hit

string<date-time>

Example:

"2024-06-19T06:33:30Z"

data.latency

number<double>

Example:

0

data.max_latency

integer<int64>

Example:

0

data.max_upstream_latency

integer<int64>

Example:

0

data.min_latency

integer<int64>

Example:

0

data.min_upstream_latency

integer<int64>

Example:

0

data.request_time

number<double>

Example:

190.2

data.success

integer

Example:

22

data.upstream_latency

number<double>

Example:

0

pages

integer

Overview Analytics of Oauth Client ID.

⌘I

Overview

Getting Started

Deploy Tyk

Managing APIs

Security in Tyk

Reference

Developer Support

Analytics of API Key.

Authorizations

Path Parameters

Response