Skip to content
mavirank
Register
Open app

Getting started

This page takes you from registration to your first audit and shows how to call the API with a token.

In three steps

  1. Create an account

    Register with your e-mail address and confirm it. Your first organization tries the Pro plan for 14 days and then continues on the free plan.

  2. Set up your organization

    The organization holds your plan, your limits and all data. Invite colleagues and give each of them a role: owner, admin, member or viewer.

  3. Run your first audit

    Enter the URL of a page. The audit waits in the queue for a moment and then shows the score and the issues by severity, each with an explanation and a recommendation.

API

mavirank has a REST API. Create a token under API tokens in the organization settings and give it only the scopes it needs, for example organization:read. Tokens start with mvrk_ and are shown only once.

Send the token as a bearer token. Replace {apiToken} and {organizationId} with your values.

Read the usage (curl)Shell
# Needs the scope organization:read (api-contract.md 7.1).
curl -fsS \
  -H 'Authorization: Bearer {apiToken}' \
  -H 'Accept: application/json' \
  https://mavirank.com/api/v1/organizations/{organizationId}/usage

Ready to try it?

Create a free account in a few minutes.

Create a free account