List Consumers - Apitally Docs

GET

apps

{app_id}

consumers

curl --request GET \
  --url https://api.apitally.io/v1/apps/{app_id}/consumers \
  --header 'Api-Key: <api-key>'

{
  "data": [
    {
      "id": 123,
      "identifier": "<string>",
      "name": "<string>",
      "group": {
        "id": 123,
        "name": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "last_request_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_token": "<string>"
}

Authorizations

Api-Key

string

header

required

Path Parameters

app_id

integer

required

App ID

Required range: x > 1

Query Parameters

requests_since

string | null

Filter to consumers that have made requests since the given date and time in ISO 8601 format, if given.

next_token

string | null

Token to fetch the next page of consumers, as returned by a previous request.

Maximum length: 1024

limit

integer

default:

100

Maximum number of consumers to return.

Required range: 1 < x < 1000

Response

200

application/json

Successful Response

data

object[]

required

List of consumers.

has_more

boolean

required

Whether there are more consumers to list.

next_token

string | null

required

Token to fetch the next page of consumers, if there are more.

Suggest edits Raise issue

List Apps Get Traffic

curl --request GET \
  --url https://api.apitally.io/v1/apps/{app_id}/consumers \
  --header 'Api-Key: <api-key>'

{
  "data": [
    {
      "id": 123,
      "identifier": "<string>",
      "name": "<string>",
      "group": {
        "id": 123,
        "name": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "last_request_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_token": "<string>"
}