Skip to content
RouteSeam

Request counts for the domain

GET
/api/v1/domains/{domain_id}/analytics
curl --request GET \
  --url https://app.routeseam.com/api/v1/domains/1/analytics \
  --header 'X-Api-Key: <X-Api-Key>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
domain_id
required
integer

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
analytics
required
object
requests
required
object
today
required
integer
last_7_days
required
integer
last_30_days
required
integer
Examplegenerated
{
  "analytics": {
    "requests": {
      "today": 1,
      "last_7_days": 1,
      "last_30_days": 1
    }
  }
}

401

Section titled “401”

Missing or invalid API key

Media typeapplication/json

The ONLY error envelope — produced by Api::V1::BaseController#render_error_response

object
error
required
string
errors
Array<string>
validation_errors
object
key
additional properties
Array<string>
Example
{
  "error": "Invalid API key",
  "errors": [],
  "validation_errors": {}
}

404

Section titled “404”

Not found (cross-tenant ids are indistinguishable from missing ones)

Media typeapplication/json

The ONLY error envelope — produced by Api::V1::BaseController#render_error_response

object
error
required
string
errors
Array<string>
validation_errors
object
key
additional properties
Array<string>
Example
{
  "error": "Not found",
  "errors": [],
  "validation_errors": {}
}

429

Section titled “429”

Over 300 requests/minute for this key

Media typeapplication/json

The ONLY error envelope — produced by Api::V1::BaseController#render_error_response

object
error
required
string
errors
Array<string>
validation_errors
object
key
additional properties
Array<string>
Example
{
  "error": "Rate limit exceeded",
  "errors": [],
  "validation_errors": {}
}