Partner API

The Partner API connects your own system to your partner area.

The endpoints sit under https://hub.webmetic.de, like the rest of the API. They are also part of the API reference, where you can try each endpoint in the Playground.

In the Playground you need the key of your partner account. The partner endpoints reject the prefilled demo key with status 403. With your key every request is real: POST /partner/create-customer creates a real customer, and DELETE really removes a website.

AccessCopy Anchor Link

The Partner API needs an account with a partner area. How to become a partner is described under Partners.

The Partner API uses the Visitor Intelligence key of your partner account, not a separate partner key. Only admins find it under Menu > Integrations > API.

Send the key unchanged in the Authorization header, without a Bearer prefix. Authentication describes its format and errors.

If the key belongs to an account without a partner area, the API answers with NOT_A_PARTNER.

When you regenerate the key, the old one stops working. This affects your partner requests and the requests for your own visit data.

Requests to the partner endpoints cost no credits.

EndpointsCopy Anchor Link

The limits apply per endpoint. If you exceed a limit, the API answers with status 429, and you repeat the request after a pause.

New customerCopy Anchor Link

POST /partner/create-customer creates an account for your customer and takes a JSON body with these fields:

Webmetic cuts website down to the main domain and stores it in lower case. https://www.Customer-Example.com/pricing becomes customer-example.com, and so does shop.customer-example.com.

curl -X POST "https://hub.webmetic.de/partner/create-customer" \
  -H "Authorization: wmtc_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email": "contact@customer-example.com", "website": "customer-example.com", "whitelabel": true}'

The response contains the login details of the new account:

{
  "account_id": "CUSTOMER_ACCOUNT_ID",
  "email": "contact@customer-example.com",
  "password": "pX7kTq2mWb9R",
  "api_key": "wmtc_CUSTOMER_API_KEY",
  "status": "partner_trial",
  "account_type": "partner_customer",
  "website": "customer-example.com",
  "whitelabel": true
}

The account has one user with the Admin role and a random password. Store the password right away, because Webmetic never returns it a second time.

Because Webmetic sends no login details when you create a customer through the API, you pass the email address and password on to your customer yourself.

Your customer can sign in with them at once, also on your white-label domain.

You invoice the new customer. A white-label customer sees the features you turn on under Choose features for customers.

Through the API you set whitelabel only at creation, and later you change the value on the customer page in the dashboard.

Data only arrives once the tracking code with the customer's account ID runs on their website. How to hand over the code is described under Add customers.

Customer list and single customerCopy Anchor Link

GET /partner/customers returns all customers of your partner account, newest first. The list also includes customers you created in the dashboard.

count is the number of customers on this page, total the number of all customers. To page on, raise offset by limit until offset reaches total.

{
  "customers": [
    {
      "account_id": "CUSTOMER_ACCOUNT_ID",
      "account": "customer-example",
      "email": "contact@customer-example.com",
      "status": "partner_trial",
      "account_type": "partner_customer",
      "api_key": "wmtc_CUSTOMER_API_KEY",
      "websites": ["customer-example.com"],
      "usage": [],
      "whitelabel": true,
      "created_at": "2026-10-22T09:14:03.512000"
    }
  ],
  "count": 1,
  "total": 1,
  "limit": 100,
  "offset": 0,
  "partner_account_id": "YOUR_ACCOUNT_ID"
}

GET /partner/customers/CUSTOMER_ACCOUNT_ID returns one customer with the same fields. For an unknown account ID and for another partner's customer the API answers the same way: 404 with CUSTOMER_NOT_FOUND.

Customer fieldsCopy Anchor Link

Base your logic on account_type, not on status, because account_type is the field that says who invoices.

An entry in usage contains these fields, among others:

The dashboard also shows a customer's account ID and API key under Menu > Partner area > Customers, on the customer page under Account details.

Customer websitesCopy Anchor Link

POST /partner/customers/CUSTOMER_ACCOUNT_ID/websites adds a website, with the body {"website": "customer-example.com"}. Webmetic cuts the value down to the main domain, as at creation.

If the customer already has this domain or another Webmetic account uses it, the API answers with 409. This also applies to subdomains, because Webmetic collects them under the main domain, see Track subdomains.

DELETE /partner/customers/CUSTOMER_ACCOUNT_ID/websites/DOMAIN removes a domain, written exactly as websites shows it.

Webmetic only removes the entry and deletes no visit data. The account stays in place, even when it has no website left.

Both endpoints answer with the full list:

{"account_id": "CUSTOMER_ACCOUNT_ID", "websites": ["customer-example.com"]}

Your customers' visit dataCopy Anchor Link

With your key you read the visit data of every domain listed in websites of one of your customers. This covers /company-sessions, /company, /company_nace, /session, /session_user_data, /intensive-visits, /returning-visits and /new-visits.

You get the same data as with the customer's key. Parameters, paging and responses are the same as in the API reference.

The same limit of one request per second per endpoint applies, along with these rules:

• Pass domain exactly in the stored spelling: without https://, without www., in the same upper and lower case. Otherwise the API answers with 403 and API_KEY_NOT_AUTHORIZED.
• /company accepts domain several times and merges the companies of several customers. The response does not say which customer a company belongs to.
• The limits of the customer's account apply. If Webmetic invoices the customer and they are on the Free plan, some companies are hidden.
• After you remove a domain, requests for it answer with API_KEY_NOT_AUTHORIZED, with your key and with the customer's.

Your key does not reach contacts and Enrichment, so for Contacts you use the customer's own api_key.

Searching for contacts needs the contacts setup in the customer's dashboard. Unlocking an email address or phone number costs their credits.

Enrichment uses the Enrichment key of the account in question.

ErrorsCopy Anchor Link

Errors have the same format as in the rest of the API, for example status 404 for an unknown account ID:

{
  "detail": {
    "error": "CUSTOMER_NOT_FOUND",
    "message": "No customer with this account id."
  }
}

Check the code in detail.error. The English text in detail.message is meant for people and can change. For details, see Errors.

LimitationsCopy Anchor Link

• The Partner API sends no webhooks, so you fetch new data per domain. Webhooks exist per Webmetic account. For details, see Webhooks.
• You set up the white-label domain, branding and features for customers in the dashboard.
• You change who invoices a customer on the customer page in the dashboard.
• Only the response at creation contains a customer's password.

Next stepsCopy Anchor Link