Get project

Returns the data of the project associated with the provided API key.


Method

GET

Path

/v1/project

This endpoint lets you programmatically fetch the token, or other settings and metadata, of the project linked to your API key.

Headers

Authorization

required

Bearer token for a project API key. This endpoint returns data for that project only.

Example: Bearer vem_abcdefghijklmnopqrstuvwxyz123456

Responses

200 Success
application/json

project

Description
Project data associated with the provided API key.
Type
object

id

Description
Unique project identifier
Type
string
Example
"4232882524803099"

name

Description
Name of the project
Type
string
Example
"Vemetric"

domain

Description
Primary domain of the project
Type
string
Example
"vemetric.com"

token

Description
Public token used for tracking
Type
string
Example
"project_token_123"

createdAt

Description
Project creation timestamp (ISO 8601)
Type
string
Example
"2026-02-07T12:00:00.000Z"

firstEventAt

Description
Timestamp of the first ingested event, if available (ISO 8601)
Type
string | null
Example
"2026-02-07T12:30:00.000Z"

hasPublicDashboard

Description
Whether the project has public dashboard access enabled
Type
boolean
Example
false

excludedIps

Description
List of excluded IP Addresses
Type
array<string>
Example
["127.0.0.1"]

excludedCountries

Description
List of excluded countries as ISO 3166-1 alpha-2 codes
Type
array<string>
Example
["DE","AT"]


400 Bad request - invalid request payload or parameters
application/json

error

Description
Validation error details.
Type
object

code

Description
Machine-readable validation error code.
Type
"VALIDATION_ERROR"

message

Description
Human-readable validation summary.
Type
string

details

Description
Per-field validation issues.
Type
array<object>
Show nested properties (2)

field

Description
Path to the invalid request field.
Type
string
Example
"groupBy.0"

message

Description
Validation error message for the field.
Type
string



401 Unauthorized - invalid or revoked API key
application/json

error

Description
Error details.
Type
object

code

Description
Machine-readable error code.
Type
"UNAUTHORIZED"

message

Description
Human-readable error message.
Type
string


429 Rate limit exceeded
application/json

error

Description
Error details.
Type
object

code

Description
Machine-readable error code.
Type
"RATE_LIMIT_EXCEEDED"

message

Description
Human-readable error message.
Type
string


500 Unexpected internal error
application/json

error

Description
Error details.
Type
object

code

Description
Machine-readable error code.
Type
"INTERNAL_SERVER_ERROR"

message

Description
Human-readable error message.
Type
string


Ready to understand your users?

Start tracking
Pricing About Documentation Customers Changelog Blog