Skip to content
Pomelo Analytics

Current API principal and plan limits

GET
/v1/me
curl --request GET \
  --url https://api.pomeloanalytics.com/v1/me \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
X-Request-Id
string

Optional idempotency/request correlation identifier.

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
org_id
required
string
plan_id
required

Deprecated compatibility mirror of product.runtime_plan_id. The canonical product object is product. This field is retained for compatibility and must not be used by new integrations. No removal will happen before 2026-07-03T00:00:00Z.

string
Allowed values: free starter pro
retention_days
required

Deprecated compatibility mirror of product.product_retention.api_retention_days. This field is retained for compatibility and must not be used by new integrations. No removal will happen before 2026-07-03T00:00:00Z.

integer
quotas
required
object
included_units
required
integer
used_units
required
integer
overage_units
required
integer
hard_cap_units
required
integer
reset_at
required
string format: date-time
rate_limits
required
object
rps
required
integer
docs_url
required
string format: uri
product
required
object
runtime_plan_id
required
string
Allowed values: free starter pro
default_collection_profile
required
string
Allowed values: strict extended
quotas
required
object
events_included
required
integer
sites_included
required
integer
users_included
required
integer
nullable
hard_site_limit
required
integer
hard_user_limit
required
integer
nullable
product_retention
required
object
workspace_retention
required
object
kind
required
string
Allowed values: fixed custom
value
integer
unit
string
Allowed values: days months
api_retention_days
integer
nullable
api
required
object
availability
required
string
Allowed values: none limited standard custom
can_create_tokens
required
boolean
allow_reports
required
boolean
allow_goals
required
boolean
allow_tenants
required
boolean
allow_tenant_dimension
required
boolean
retention_days
integer
nullable
monthly_included_units
integer
nullable
hard_cap_units
integer
nullable
rate_limit_rps
integer
nullable
max_range_days
required
integer
max_breakdown_limit
required
integer
max_report_limit
required
integer
usage_history_months
required
integer
exports
required
object
csv
required
boolean
level
required
string
Allowed values: none limited standard guardrailed advanced custom
dashboard
required
object
hourly_enabled
required
boolean
hourly_level
required
string
Allowed values: none limited standard guardrailed advanced custom
essential_level
required
string
Allowed values: none limited standard guardrailed advanced custom
standard_level
required
string
Allowed values: none limited standard guardrailed advanced custom
breakdowns_standard_level
required
string
Allowed values: none limited standard guardrailed advanced custom
breakdowns_high_cardinality_level
required
string
Allowed values: none limited standard guardrailed advanced custom
team_management_level
required
string
Allowed values: none limited standard guardrailed advanced custom
capabilities
required
object
collection
required
object
level
required
string
Allowed values: none limited standard guardrailed advanced custom
data_envelope
required
string
Allowed values: strict extended mixed
maturity
required
string
Allowed values: implemented partially_implemented not_explicitly_split not_applicable
notes
required
Array<string>
reports
required
object
level
required
string
Allowed values: none limited standard guardrailed advanced custom
data_envelope
required
string
Allowed values: strict extended mixed
maturity
required
string
Allowed values: implemented partially_implemented not_explicitly_split not_applicable
notes
required
Array<string>
dashboard_surfaces
required
Array<string>
acquisition
required
object
level
required
string
Allowed values: none limited standard guardrailed advanced custom
data_envelope
required
string
Allowed values: strict extended mixed
maturity
required
string
Allowed values: implemented partially_implemented not_explicitly_split not_applicable
notes
required
Array<string>
advanced_actions
required
object
level
required
string
Allowed values: none limited standard guardrailed advanced custom
data_envelope
required
string
Allowed values: strict extended mixed
maturity
required
string
Allowed values: implemented partially_implemented not_explicitly_split not_applicable
notes
required
Array<string>
multi_tenant
required
object
level
required
string
Allowed values: none limited standard guardrailed advanced custom
data_envelope
required
string
Allowed values: strict extended mixed
maturity
required
string
Allowed values: implemented partially_implemented not_explicitly_split not_applicable
notes
required
Array<string>
exports
required
object
level
required
string
Allowed values: none limited standard guardrailed advanced custom
data_envelope
required
string
Allowed values: strict extended mixed
maturity
required
string
Allowed values: implemented partially_implemented not_explicitly_split not_applicable
notes
required
Array<string>
api
required
object
level
required
string
Allowed values: none limited standard guardrailed advanced custom
data_envelope
required
string
Allowed values: strict extended mixed
maturity
required
string
Allowed values: implemented partially_implemented not_explicitly_split not_applicable
notes
required
Array<string>
Example
{
  "plan_id": "free",
  "product": {
    "runtime_plan_id": "free",
    "default_collection_profile": "strict",
    "product_retention": {
      "workspace_retention": {
        "kind": "fixed",
        "unit": "days"
      }
    },
    "api": {
      "availability": "none"
    },
    "exports": {
      "level": "none"
    },
    "dashboard": {
      "hourly_level": "none",
      "essential_level": "none",
      "standard_level": "none",
      "breakdowns_standard_level": "none",
      "breakdowns_high_cardinality_level": "none",
      "team_management_level": "none"
    },
    "capabilities": {
      "collection": {
        "level": "none",
        "data_envelope": "strict",
        "maturity": "implemented"
      },
      "reports": {
        "level": "none",
        "data_envelope": "strict",
        "maturity": "implemented"
      },
      "acquisition": {
        "level": "none",
        "data_envelope": "strict",
        "maturity": "implemented"
      },
      "advanced_actions": {
        "level": "none",
        "data_envelope": "strict",
        "maturity": "implemented"
      },
      "multi_tenant": {
        "level": "none",
        "data_envelope": "strict",
        "maturity": "implemented"
      },
      "exports": {
        "level": "none",
        "data_envelope": "strict",
        "maturity": "implemented"
      },
      "api": {
        "level": "none",
        "data_envelope": "strict",
        "maturity": "implemented"
      }
    }
  }
}

Headers

Section titled “Headers”
X-Request-Id
string

Request identifier for troubleshooting.

X-RateLimit-Limit
integer

Maximum requests allowed during current short window.

X-RateLimit-Remaining
integer

Remaining requests in current short window.

X-RateLimit-Reset
integer

Unix timestamp when short window resets.

401

Section titled “401”

Invalid or revoked API token.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: UNAUTHORIZED FORBIDDEN INVALID_METHOD INVALID_PARAMS RETENTION_EXCEEDED RATE_LIMITED HARD_CAP_REACHED REPORT_LOCKED_BY_PROFILE REPORT_NOT_AVAILABLE_FOR_REQUESTED_PERIOD REPORT_RESPONSE_TOO_LARGE INTERNAL_ERROR NOT_FOUND
message
required
string
request_id
required
string
details
object
key
additional properties
any
Example
{
  "error": {
    "code": "UNAUTHORIZED"
  }
}

Headers

Section titled “Headers”
X-Request-Id
string

Request identifier for troubleshooting.

429

Section titled “429”

Request was throttled.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: UNAUTHORIZED FORBIDDEN INVALID_METHOD INVALID_PARAMS RETENTION_EXCEEDED RATE_LIMITED HARD_CAP_REACHED REPORT_LOCKED_BY_PROFILE REPORT_NOT_AVAILABLE_FOR_REQUESTED_PERIOD REPORT_RESPONSE_TOO_LARGE INTERNAL_ERROR NOT_FOUND
message
required
string
request_id
required
string
details
object
key
additional properties
any
Example
{
  "error": {
    "code": "UNAUTHORIZED"
  }
}

Headers

Section titled “Headers”
X-Request-Id
string

Request identifier for troubleshooting.

X-RateLimit-Limit
integer

Maximum requests allowed during current short window.

X-RateLimit-Remaining
integer

Remaining requests in current short window.

X-RateLimit-Reset
integer

Unix timestamp when short window resets.