Bericht ausführen

curl --request GET \
  --url https://app.pricepirate.com/api/v1/reports/{report} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://app.pricepirate.com/api/v1/reports/{report}', 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://app.pricepirate.com/api/v1/reports/{report}",
  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://app.pricepirate.com/api/v1/reports/{report}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://app.pricepirate.com/api/v1/reports/{report}")

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

{
  "points": [
    {
      "date": "2025-01-01",
      "avgPrice": 99.9
    }
  ]
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "JSON body must be an object",
    "details": "Validation details may be included for invalid inputs.",
    "requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid Authorization header",
    "requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Forbidden",
    "requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
  }
}

{
  "error": {
    "code": "TOO_MANY_REQUESTS",
    "message": "Rate limit exceeded",
    "requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
  }
}

{
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "Internal server error",
    "requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
  }
}

{
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "Internal server error",
    "requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
  }
}

Autorisierungen

Authorization

string

header

erforderlich

Public-API-Token, das als Authorization: Bearer übergeben wird.

Pfadparameter

report

enum<string>

erforderlich

Berichtskennung.

Verfügbare Optionen:

average-price-trend,

cheapest-trend,

competitor-leaderboard,

headroom-and-exposure,

offers-trend,

position-distribution,

price-ranges,

price-change-funnel,

price-change-status-trend,

price-direction-heatmap,

volatility-list

Abfrageparameter

timeWindow

enum<string>

Berichtszeitfenster, das von allen Berichten verwendet wird.

Verfügbare Optionen:

7d,

14d,

30d

variantIds

string[]

Filtern Sie Berichte auf bestimmte Shopify-Produktvarianten-IDs. Wird von allen Berichten außer volatility-list verwendet. Wiederholen Sie den Parameter oder übergeben Sie eine kommagetrennte Liste.

collectionId

string

Filtern Sie Berichte auf Varianten in einer Shopify-Kollektion. Wird von allen Berichten außer volatility-list verwendet.

source

enum<string>

Preisquelle, die abgefragt werden soll.

Verfügbare Optionen:

IDEALO,

GOOGLE_SHOPPING,

KLARNA,

PRICERUNNER,

ALLEGRO,

AMAZON

country

enum<string>

Markt-Ländercode, der abgefragt werden soll.

Verfügbare Optionen:

AE,

AT,

AU,

BE,

BG,

BR,

CA,

CH,

CN,

CZ,

DE,

DK,

ES,

FI,

FR,

GR,

HR,

HU,

IE,

IN,

IT,

JP,

NL,

NO,

PL,

PT,

RO,

MX,

SE,

SK,

UK,

US

priceBasis

enum<string>

Preisgrundlage, die von cheapest-trend, position-distribution und price-ranges verwendet wird.

Verfügbare Optionen:

price,

total

page

integer

Seitennummer, beginnend bei 1, die von competitor-leaderboard verwendet wird.

Erforderlicher Bereich: 1 <= x <= 100000

perPage

integer

Einträge pro Seite, die von competitor-leaderboard verwendet werden.

Erforderlicher Bereich: 1 <= x <= 100

sortBy

enum<string>

Sortierfeld, das von competitor-leaderboard verwendet wird.

Verfügbare Optionen:

shopName,

sharedListings,

timesRankOne,

undercutShare,

avgPosition,

timesRankOneByPrice,

timesRankOneByTotal,

undercutShareByPrice,

undercutShareByTotal,

avgPricePosition,

avgTotalPosition,

avgShipping

sortDirection

enum<string>

Sortierrichtung, die von competitor-leaderboard verwendet wird.

Verfügbare Optionen:

asc,

desc

shopNameSearch

string

Suche nach Wettbewerber-Shopnamen ohne Beachtung der Groß- und Kleinschreibung, die von competitor-leaderboard verwendet wird.

headroomLimit

integer

Maximale Anzahl von Headroom-Zeilen, die von headroom-and-exposure verwendet wird.

Erforderlicher Bereich: 1 <= x <= 50

exposureLimit

integer

Maximale Anzahl von Exposure-Zeilen, die von headroom-and-exposure verwendet wird.

Erforderlicher Bereich: 1 <= x <= 50

limit

integer

Maximale Anzahl von Zeilen, die von price-ranges und volatility-list verwendet wird.

Erforderlicher Bereich: 1 <= x <= 50

Antwort

Erfolgreiche Antwort.

The response is of type object.

Variantenmetriken abrufen

Zurück

Übersicht

Weiter

Bericht ausführen

curl --request GET \
  --url https://app.pricepirate.com/api/v1/reports/{report} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://app.pricepirate.com/api/v1/reports/{report}', 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://app.pricepirate.com/api/v1/reports/{report}",
  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://app.pricepirate.com/api/v1/reports/{report}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://app.pricepirate.com/api/v1/reports/{report}")

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

{
  "points": [
    {
      "date": "2025-01-01",
      "avgPrice": 99.9
    }
  ]
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "JSON body must be an object",
    "details": "Validation details may be included for invalid inputs.",
    "requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid Authorization header",
    "requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Forbidden",
    "requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
  }
}

{
  "error": {
    "code": "TOO_MANY_REQUESTS",
    "message": "Rate limit exceeded",
    "requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
  }
}

{
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "Internal server error",
    "requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
  }
}

{
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "Internal server error",
    "requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
  }
}

Admin API

Price Data API

Hilfe

Produkt

Unternehmen

Bericht ausführen

Autorisierungen

Pfadparameter

Abfrageparameter

Antwort