Vemetric REST API

Here you can find all the information you need to get started with our API.

The Vemetric API lets you read project data and integrate Vemetric into your own tooling.

Base URL

The API is available at https://api.vemetric.com

We also have an OpenAPI Spec (openapi.json) for easy integration with API clients and documentation tools.

Authentication

Authenticate using your private API key as a bearer token:

Authorization: Bearer <YOUR_API_KEY>

Keep your API key private

Never expose private API keys in frontend code. Use your backend or serverless functions for API calls.

Manage API Keys

API Keys are managed per project, so you need to visit the settings page of your project and navigate to the API tab. There you can create new keys and revoke existing ones.

Once you’ve created the API Key, make sure to copy it and store it securely. You won’t be able to see the full key again after you leave the page.

Treat your API keys like passwords. Store each key in your secrets manager or environment variables, never in source code. Avoid sending keys in URLs or logs; always use the Authorization header.

If a key gets compromised:

1. Revoke the affected key in Project Settings.
2. Create a replacement key.
3. Update all dependent services and redeploy.
4. Monitor for new 401 errors from services that still use the old key.

Available endpoints

Here you can see all the available endpoints, categorized by their functionality. Click on each endpoint to see more details about the request and response format, as well as example requests.

As API Keys are currently scoped to projects, all endpoints operate and return data corresponding to the project linked to the provided API key.