Get performance report

curl --request GET \
  --url https://api.lomadee.com.br/brand/whitelabel/reports/performance \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.lomadee.com.br/brand/whitelabel/reports/performance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lomadee.com.br/brand/whitelabel/reports/performance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lomadee.com.br/brand/whitelabel/reports/performance"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.lomadee.com.br/brand/whitelabel/reports/performance")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "date": "2023-12-25",
      "affiliate": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "orders": 123,
      "approvedOrders": 123,
      "revenue": 123,
      "commission": 123
    }
  ],
  "meta": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "totalPages": 123
  }
}

{
  "success": false,
  "message": "limit must not be greater than 100",
  "code": "BAD_REQUEST"
}

{
  "success": false,
  "message": "Invalid API key",
  "code": "UNAUTHORIZED"
}

{
  "success": false,
  "message": "Insufficient scope",
  "code": "FORBIDDEN"
}

{
  "success": false,
  "message": "Too many requests",
  "code": "TOO_MANY_REQUESTS"
}

GET

brand

whitelabel

reports

performance

Get performance report

curl --request GET \
  --url https://api.lomadee.com.br/brand/whitelabel/reports/performance \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.lomadee.com.br/brand/whitelabel/reports/performance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lomadee.com.br/brand/whitelabel/reports/performance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lomadee.com.br/brand/whitelabel/reports/performance"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.lomadee.com.br/brand/whitelabel/reports/performance")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "date": "2023-12-25",
      "affiliate": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "orders": 123,
      "approvedOrders": 123,
      "revenue": 123,
      "commission": 123
    }
  ],
  "meta": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "totalPages": 123
  }
}

{
  "success": false,
  "message": "limit must not be greater than 100",
  "code": "BAD_REQUEST"
}

{
  "success": false,
  "message": "Invalid API key",
  "code": "UNAUTHORIZED"
}

{
  "success": false,
  "message": "Insufficient scope",
  "code": "FORBIDDEN"
}

{
  "success": false,
  "message": "Too many requests",
  "code": "TOO_MANY_REQUESTS"
}

Returns orders, approved orders, revenue and commission for a period, grouped by day or by affiliate. This endpoint has its own limit of 10 requests per minute. Requires scope whitelabel:reports:read.

Authorizations

x-api-key

string

header

required

Brand key created in the dashboard.

Query Parameters

from

string<date-time>

required

Start of the period (ISO 8601).

string<date-time>

required

End of the period (ISO 8601). At most 90 days after from.

groupBy

enum<string>

default:day

How rows are grouped.

Available options:

day,

affiliate

page

integer

default:1

Page number.

Required range: x >= 1

limit

integer

default:20

Items per page. Values above 100 return 400.

Required range: 1 <= x <= 100

Response

Report rows

data

object[]

required

Show child attributes

Get started

Guides

Concepts

Network reference

White label reference

Get performance report

Authorizations

Query Parameters

Response