Skip to main content
All CollectionsGetting Started Optional SetupData Integration and Tools
How to retrieve data using API endpoints
How to retrieve data using API endpoints

Details about how to retrieve data from our platform using API endpoints.

Admetrics avatar
Written by Admetrics
Updated over 3 months ago

The API allows you to programmatically access your e-commerce data for integration with your systems.

Getting Started

API Key

To begin using the API, you need to request an API key. The API key is valid for a limited period (2 years) and is used to authenticate your requests.

  1. Requesting an API Key: To request an API key, please contact our support team and specify the intended use of the API.

  2. Refreshing the token: If you receive a refresh token, you can use it to obtain new access and refresh tokens. The request for refreshing the access token is made to the following endpoint: https://app.admetrics.io/api/users/refresh

    This should be a GET request, and it must include your refresh token in the Authorization: Bearer header.

Making Requests

Endpoint

All API requests should be made to the following endpoint:

<https://app.admetrics.io/apiv3/query>

HTTP Method

All requests to this endpoint should use the POST method.

Authorization

When making requests to the API, you must include your API key in the Authorization header. The header format is as follows:

Authorization: Bearer YOUR_API_KEY

Request Payload

The payload for your request will depend on the specific query you want to perform. To simplify the process of building your request, you can use Data Studio to generate the necessary payload.

  1. Open Data Studio

    Navigate to the Performance view and configure it to retrieve the desired data.

  2. Inspect Network Requests

    Use your browser's developer tools to inspect the network requests made to the endpoint. Look for requests going to https://app.admetrics.io/apiv3/query.

  3. Copy Payload

    Copy the request payload from the inspected network request.

  4. Replace query_id

    In the payload you copied, replace the query_id with a unique UUID v4. You can generate a UUID v4 using various online tools or libraries in most programming languages.

Response

The API will respond with the requested data in JSON format. You can check the response details in the network panel of your browser's developer tools.

Error Handling

  • In case of critical errors, the server will respond with a 500 Internal Server Error.

  • Less critical errors will return a response with a status key that does not equal 200.

Did this answer your question?