Metrics monthly

This route allows you to get the cashbacks of a specific consumer, ventilated per status and per month. Cashback Status are :

PENDING Cashback has been generated, but is not yet validated (PENDING_VALIDATION) total_pending_cashback_amount
VALIDATED A cashback that has passed the validation period (e.g. 14 days of retraction for a classical purchase). The cashback can’t be cancelled when validated total_validated_cashback_amount
PAID_IN Cashback money has been collected from the merchant, but not yet transfered (paid out) to the consumer. total_paid_in_cashback_amount
PAID_OUT Cashback money has been transfered to the consumer pay out account. total_paid_out_cashback_amount
CANCELLED The cashback has been cancelled. total_cancelled_cashback_amount We also return the total number of cashbacks since user acceptance of the terms of services and the total amount of cashback, whatever the status is. Dont compute cancelled cashbacks in total amount and total cashbacks This is especially useful for programs with cagnotte, allowing to show how much money have been collected so far, but not yet transferred to the consumer.

GET

connectors

consumers

{consumer_id}

metrics

by_month

Metrics monthly

curl --request GET \
  --url https://api.sandbox.paylead.tech/connectors/consumers/{consumer_id}/metrics/by_month \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sandbox.paylead.tech/connectors/consumers/{consumer_id}/metrics/by_month"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sandbox.paylead.tech/connectors/consumers/{consumer_id}/metrics/by_month', 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.sandbox.paylead.tech/connectors/consumers/{consumer_id}/metrics/by_month",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.sandbox.paylead.tech/connectors/consumers/{consumer_id}/metrics/by_month"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.paylead.tech/connectors/consumers/{consumer_id}/metrics/by_month")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.paylead.tech/connectors/consumers/{consumer_id}/metrics/by_month")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

[
  {
    "date": "2018-12-26T13:45:36.173196+00:00",
    "total_cashback": 34,
    "total_cashback_amount": 438.12,
    "total_paid_in_cashback_amount": 1456.32,
    "total_paid_out_cashback_amount": 135.83,
    "total_pending_cashback_amount": 76.3,
    "total_validated_cashback_amount": 246.78,
    "total_vouchers": 51,
    "total_vouchers_savings_amount": 246.79
  }
]

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

consumer_id

string

required

The id you used to create the given consumer

Response

date

string<date-time>

Object creation datetime

Example:

"2018-12-26T13:45:36.173196+00:00"

total_cashback

number

Number of cashbacks

Example:

34

total_cashback_amount

number

Sum of cashback amounts

Example:

438.12

total_paid_in_cashback_amount

number

Sum of paid in cashback amounts

Example:

1456.32

total_paid_out_cashback_amount

number

Sum of paid out cashback amounts

Example:

135.83

total_pending_cashback_amount

number

Sum of pending cashback amounts

Example:

76.3

total_validated_cashback_amount

number

Sum of validated cashback amounts

Example:

246.78

total_vouchers

number

Number of vouchers ordered

Example:

51

total_vouchers_savings_amount

number

Sum of discounts on vouchers ordered

Example:

246.79

Offers Consumer Listing Gets a paginated list of all offers available for the current consumer: generic offers + offers where this consumer is targeted. For all your logged consumers, you must actually use this route to retrieve the best set of offers dedicated to each consumer. This list can be filtered by offer types, start date, end date, universe, highlight level... The list contains all the active offers (status = ACTIVE) and offers to come (status = PUBLISHED). This list is sorted by default using the conversion probability computed by our internal smart ranking engine. Pagination of 20 items by default.

⌘I

Metrics monthly

curl --request GET \
  --url https://api.sandbox.paylead.tech/connectors/consumers/{consumer_id}/metrics/by_month \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sandbox.paylead.tech/connectors/consumers/{consumer_id}/metrics/by_month"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sandbox.paylead.tech/connectors/consumers/{consumer_id}/metrics/by_month', 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.sandbox.paylead.tech/connectors/consumers/{consumer_id}/metrics/by_month",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.sandbox.paylead.tech/connectors/consumers/{consumer_id}/metrics/by_month"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.paylead.tech/connectors/consumers/{consumer_id}/metrics/by_month")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.paylead.tech/connectors/consumers/{consumer_id}/metrics/by_month")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

[
  {
    "date": "2018-12-26T13:45:36.173196+00:00",
    "total_cashback": 34,
    "total_cashback_amount": 438.12,
    "total_paid_in_cashback_amount": 1456.32,
    "total_paid_out_cashback_amount": 135.83,
    "total_pending_cashback_amount": 76.3,
    "total_validated_cashback_amount": 246.78,
    "total_vouchers": 51,
    "total_vouchers_savings_amount": 246.79
  }
]