Sales

GET

api

stats

sales

Sales

curl --request GET \
  --url https://{search_zone}-api.doofinder.com/api/v2/stats/sales \
  --header 'Authorization: <api-key>'

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

fetch('https://{search_zone}-api.doofinder.com/api/v2/stats/sales', 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://{search_zone}-api.doofinder.com/api/v2/stats/sales",
  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: <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://{search_zone}-api.doofinder.com/api/v2/stats/sales"

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

	req.Header.Add("Authorization", "<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://{search_zone}-api.doofinder.com/api/v2/stats/sales")

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

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

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

{
  "results": [
    {
      "amount": 2.2,
      "session": "24cb1eccd1cf4a67d071f2deeac75e33"
    },
    {
      "amount": 1,
      "session": "a4eaf92a223c024b7c6680dc807c3f84"
    }
  ],
  "total": 2,
  "total_amount": 3.2
}

{
  "error": {
    "code": "bad_params",
    "message": "Bad parameters error"
  }
}

{
  "error": {
    "code": "not_authenticated",
    "message": "Authentication required"
  }
}

{
  "error": {
    "code": "access_denied",
    "message": "Access denied"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Not found"
  }
}

{
  "error": {
    "code": "timeout",
    "message": "Request timed out"
  }
}

{
  "error": {
    "code": "too_many_requests",
    "message": "Too many requests"
  }
}

Authorizations

Authorization

string

header

default:Token <your_api_key>

required

Doofinder API key. The Token prefix is part of the header value, so enter it too — the field is sent verbatim as:

Authorization: Token <api_key>

Query Parameters

from

string

required

Start date of the period in the format of UNIX timestamp or YYYYMMDD.

Pattern: ^20\d{2}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$|^\d{10}|^\d{13}$

string

required

End date of the period in the format of UNIX timestamp or YYYYMMDD.

Pattern: ^20\d{2}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$|^\d{10}$|^\d{13}

hashids

string[]

Unique id of the search engine. It accepts an array of values. If you want to work with all user search engines just don't send this parameter. Arrays parameters must be in the format param[]=value.

Pattern: ^[a-f0-9]{32}$

hashid

string[]

Pattern: ^[a-f0-9]{32}$

string

default:Etc/UTC

The timezone for the given dates, by default, assumes ETC/UTC. In naming your time zones, you must stick to those indicated in the TZ database name column here

format

enum<string>

default:json

Indicates which response format should be used

Available options:

json,

csv

device

enum<string>

Filter by kind of device.

Available options:

desktop,

mobile

aggregate

boolean

default:true

Flag to indicate when to aggregate all Search Engines stats data.

Response

Sales retrieved.

Stats results for Sales.

results

object[]

Show child attributes

total

integer

Count of all sales retrieved.

Example:

1

total_amount

integer

Total sum of all sales amount.

Example:

12

Sales

curl --request GET \
  --url https://{search_zone}-api.doofinder.com/api/v2/stats/sales \
  --header 'Authorization: <api-key>'

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

fetch('https://{search_zone}-api.doofinder.com/api/v2/stats/sales', 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://{search_zone}-api.doofinder.com/api/v2/stats/sales",
  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: <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://{search_zone}-api.doofinder.com/api/v2/stats/sales"

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

	req.Header.Add("Authorization", "<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://{search_zone}-api.doofinder.com/api/v2/stats/sales")

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

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

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

{
  "results": [
    {
      "amount": 2.2,
      "session": "24cb1eccd1cf4a67d071f2deeac75e33"
    },
    {
      "amount": 1,
      "session": "a4eaf92a223c024b7c6680dc807c3f84"
    }
  ],
  "total": 2,
  "total_amount": 3.2
}

{
  "error": {
    "code": "bad_params",
    "message": "Bad parameters error"
  }
}

{
  "error": {
    "code": "not_authenticated",
    "message": "Authentication required"
  }
}

{
  "error": {
    "code": "access_denied",
    "message": "Access denied"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Not found"
  }
}

{
  "error": {
    "code": "timeout",
    "message": "Request timed out"
  }
}

{
  "error": {
    "code": "too_many_requests",
    "message": "Too many requests"
  }
}

Overview

Endpoints

Authorizations

Query Parameters

Response