NAV Navbar

API Documentation

Return to Site

shell
  • Introduction
  • Authentication
  • Departments
  • Products
  • Annotations
  • Keywords
  • Timeseries
  • Best Seller Rankings
  • Keyword Rankings
  • Price History
  • Review History
  • Ratings History
  • Errors
  • Introduction

    The Z9 Tracker API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients.

    JSON is returned by all API responses, including errors.

    Authentication

    Example Request:

    curl "https://us.z9tracker.com/api/products" \
      -u "{API_KEY}:"
    

    curl uses the -u flag to pass basic auth credentials (adding a colon after your API key prevents cURL from asking for a password).

    Authenticate your account when using the API by including your secret API key in the request. You can manage your API key in the API section of the application. Your API key carries many privileges, so be sure to keep it secret! Do not share your secret API key in publicly accessible areas such GitHub, client-side code, and so forth.

    All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

    Departments

    Departments are used for aggregating information about a tracked product. Not every department will have BSR data or keyword rank data associated with it. For example, keyword rankings are only retrieved for the top-level departments such as All Departments or Electronics, and All Departments will have no BSR data.

    Departments are only returned as a list when retrieving products, and used when retrieving BSR and keyword data. They are not operated on directly.

    The Department Object

    Example Object

    {
      "id":4,
      "object":"department",
      "name":"3D Printer Parts & Accessories",
      "label":"Industrial & Scientific : Additive Manufacturing Products : 3D Printer Parts & Accessories",
      "has_best_seller_rankings":true,
      "has_keyword_rankings":false
    }
    

    Attributes

    Parameter Description
    id
    integer
    Unique identifier for the department
    object
    string, value is "department"
    String representing the object's type. Objects of the same type share the same value.
    name
    string
    The name of this department or part of the browse_node tree
    label
    string
    The full label of this department including any parent nodes back to the top of the index
    has_best_seller_rankings
    boolean
    True or false depending on whether or not the product in question has BSR values for this department (not always present)
    has_keyword_rankings
    boolean
    True or false depending on whether or not the product in question has keyword ranking data for this department (not always present)

    Products

    Products are individual ASINs for which you wish to track pricing changes, BSR, and keyword rankings. The API allows you to create, delete, and update the products you are tracking. You can retrieve individual products as well as list all of them.

    The Product Object

    Example Response

    {
      "id":414646533086276882,
      "object":"product",
      "asin":"B073FRZTDX",
      "title":"2-Pack NEMA 17 Stepper Steel and Rubber Vibration Dampers for 3D Printer, CNC",
      "canonical_url":"https://www.amazon.com/2-Pack-Stepper-Vibration-Dampers-Printer/dp/B073FRZTDX",
      "image_url":"https://images-na.ssl-images-amazon.com/images/I/41Vo-IZy4zL._AC_US218_.jpg",
      "created_at":"2017-11-15T21:53:57.858Z",
      "departments": {
        "object":"list",
        "data":[]
      },
      "url":"https://us.z9tracker.com/api/products/414646533086276882"
    }
    

    Attributes

    Attribute Description
    id
    integer
    Unique identifier for the product
    object
    string, value is "product"
    String representing the object's type. Objects of the same type share the same value.
    asin
    string
    Primary ASIN for this product
    title
    string
    Title as it appears on Amazon
    canonical_url
    string
    Canonical URL of the product on Amazon
    image_url
    string
    URL of one of the images on Amazon if available
    departments
    list
    List of department objects associated with this product
    tags
    string
    Tags use to assist in categorization and retrieval
    created_at
    timestamp
    Timestamp of creation
    url
    string
    Endpoint URL for this object

    Create a Product

    Definition

    POST "https://us.z9tracker.com/api/products"
    

    Example Request

    curl -X POST "https://us.z9tracker.com/api/products" \
      -u "{API_KEY}:" \
      -d "asin=B01N7TMIL7" \
      -d "tags=apple,imac" \
      -d "keywords=apple imac, apple imac refurbished"
    

    Example Response

    {
      "id":76771200412029467,
      "object":"product",
      "asin":"B01N7TMIL7",
      "title":null,
      "canonical_url":"https://www.amazon.com/dp/B01N7TMIL7",
      "image_url":null,
      "departments":{
        "object":"list",
        "data":[
          {
            "id":1,
            "object":"department",
            "name":"All Departments",
            "label":"All Departments",
            "has_best_seller_rankings":false,
            "has_keyword_rankings":true
          }
        ]
      },
      "tags":"apple imac, apple imac refurbished",
      "created_at":"2017-12-18T16:52:01.998Z",
      "url":"https://us.z9tracker.com/api/products/76771200412029467"
    }
    

    Creates a new product to begin tracking.

    Arguments

    Parameter Description
    asin
    required
    ASIN of product to track
    keywords
    optional
    Comma-separated list of keywords to track
    tags
    optional
    Comma-separated list of tags to store with the product

    Retrieve a Product

    Definition

    GET "https://us.z9tracker.com/api/products/{PRODUCT_ID}"
    

    Example Request

    curl -G "https://us.z9tracker.com/api/products/76771200412029467" \
      -u "{API_KEY}:"
    

    Example Response

    {
      "id":76771200412029467,
      "object":"product",
      "asin":"B01N7TMIL7",
      "title":null,
      "canonical_url":"https://www.amazon.com/dp/B01N7TMIL7",
      "image_url":null,
      "departments":{
        "object":"list",
        "data":[
          {
            "id":1,
            "object":"department",
            "name":"All Departments",
            "label":"All Departments",
            "has_best_seller_rankings":false,
            "has_keyword_rankings":true
          }
        ]
      },
      "tags":"taggy mctagface",
      "created_at":"2017-12-18T16:52:01.998Z",
      "url":"https://us.z9tracker.com/api/products/76771200412029467"
    }
    

    Retrieves the details of an existing product. You need only supply the unique identifier that was returned upon creation.

    Arguments

    Parameter Description
    id
    required
    The identifier of the product to be retrieved.

    Update a Product

    Definition

    PUT "https://us.z9tracker.com/api/products/{PRODUCT_ID}"
    

    Example Request

    curl -X PUT "https://us.z9tracker.com/api/products/76771200412029467" \
      -u "{API_KEY}:" \
      -d "tags=taggy mctagface"
    

    Example Response

    {
      "id":76771200412029467,
      "object":"product",
      "asin":"B01N7TMIL7",
      "title":null,
      "canonical_url":"https://www.amazon.com/dp/B01N7TMIL7",
      "image_url":null,
      "departments":{
        "object":"list",
        "data":[
          {
            "id":1,
            "object":"department",
            "name":"All Departments",
            "label":"All Departments",
            "has_best_seller_rankings":false,
            "has_keyword_rankings":true
          }
        ]
      },
      "tags":"taggy mctagface",
      "created_at":"2017-12-18T16:52:01.998Z",
      "url":"https://us.z9tracker.com/api/products/76771200412029467"
    }
    

    Updates the tags for a product

    Arguments

    Parameter Description
    id
    required
    The identifier of the product to be updated.
    tags
    required
    New comma-separated list of tags to store with the product

    Delete a Product

    Definition

    DELETE "https://us.z9tracker.com/api/products/{PRODUCT_ID}"
    

    Example Request

    curl -X DELETE "https://us.z9tracker.com/api/products/76771200412029467" \
      -u "{API_KEY}:"
    

    Example Response

    {
      "id":76771200412029467,
      "deleted":"true"
    }
    

    Permanently deletes a product and all historical tracking data. It cannot be undone.

    Arguments

    Parameter Description
    id
    required
    The identifier of the product to be deleted.

    List All Products

    Definition

    GET "https://us.z9tracker.com/api/products"
    

    Example Request

    curl -G "https://us.z9tracker.com/api/products" \
      -u "{API_KEY}:"
    

    Example Response

    {
      "object":"list",
      "url":"https://us.z9tracker.com/api/products",
      "data":[
        {
          "id":2710104796551545308,
          "object":"product",
          "asin":"B01N7TMIL7",
          "title":null,
          "canonical_url":"https://www.amazon.com/dp/B01N7TMIL7",
          "image_url":null,
          "departments":{
            "object":"list",
            "data":[
              {
                "id":1,
                "object":"department",
                "name":"All Departments",
                "label":"All Departments",
                "has_best_seller_rankings":false,
                "has_keyword_rankings":true
              }
            ]
          },
          "tags":"apple imac, apple imac refurbished",
          "created_at":"2017-12-18T19:00:12.509Z",
          "url":"https://us.z9tracker.com/api/products/2710104796551545308"
        }
      ]
    }
    

    Returns a list of your products. The products are returned sorted by creation date, with the most recent products appearing first.

    Arguments

    Parameter Description
    limit
    optional
    A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10.
    offset
    optional
    Product offset for retrieving limit number of objects, default 0.
    asin
    optional
    Filter the results to a particular ASIN. This is not case sensitive.
    tag
    optional
    Filter the results to a particular tag. This is case sensitive.

    Annotations

    Annotations are notes associated with specific products being tracked. The API allows you to create, delete, and update annotations. Deleting a tracker will also delete all annotations with which is it associated. You can retrieve individual products as well as list all of them.

    The Annotation Object

    Example Response

    {
      "id":1,
      "object": "annotation",
      "product_id":414646533086276882,
      "title":"Annotation Title",
      "body":"This is the body of an annotation",
      "timestamp":"2017-12-15T15:00:00.000Z",
      "url":"https://us.z9tracker.com/api/products/414646533086276882/annotations/1"
    }
    

    Attributes

    Attribute Description
    id
    integer
    Unique identifier for the product
    object
    string, value is "annotation"
    String representing the object's type. Objects of the same type share the same value.
    product_id
    integer
    The unique identifier of the product associated with this annotation.
    title
    string
    Title of the annotation
    body
    string
    Body of the annotation
    timestamp
    timestamp
    Timestamp for the annotation
    url
    string
    Endpoint URL for this object

    Create an Annotation

    Definition

    POST "https://us.z9tracker.com/api/products/{PRODUCT_ID}/annotations"
    

    Example Request

    curl -X POST "https://us.z9tracker.com/api/products/414646533086276882/annotations" -u "{API_KEY}:" \
      -d "title=Annotation Title" \
      -d "body=The long and detailed body of an annotation"
    

    Example Response

    {
      "id":8,
      "object":"annotations",
      "product_id":414646533086276882,
      "title":"Annotation Title",
      "body":"The long and detailed body of an annotation",
      "timestamp":"2017-12-19T22:01:19.575Z",
      "url":"https://us.z9tracker.com/api/products/414646533086276882/annotations/8"
    }
    

    Creates a new annotation for the specified product.

    Arguments

    Parameter Description
    product_id
    required
    The unique identifier of the product associated with this annotation.
    title
    required
    Title of the annotation (maximum of 64 characters)
    body
    optional
    Extended body information for the annotation (maximum of 4096 characters)
    timestamp
    optional
    Timestamp to store for the annotation. The default is the time of addition.

    Retrieve an Annotation

    Definition

    GET "https://us.z9tracker.com/api/annotations/{ANNOTATION_ID}"
    

    Example Request

    curl -G "https://us.z9tracker.com/api/annotations/8" \
      -u "{API_KEY}:"
    

    Example Response

    {
      "id":8,
      "object":"annotation",
      "product_id":414646533086276882,
      "title":"Annotation Title",
      "body":"The long and detailed body of an annotation",
      "timestamp":"2017-12-19T22:01:19.575Z",
      "url":"https://us.z9tracker.com/api/products/414646533086276882/annotations/8"
    }
    

    Retrieves the details of an annotation.

    Arguments

    Parameter Description
    annotation_id
    required
    The unique identifier of the annotation

    Update an Annotation

    Definition

    PUT "https://us.z9tracker.com/api/annotations/{ANNOTATION_ID}"
    

    Example Request

    curl -X PUT "https://us.z9tracker.com/api/annotations/8" \
      -u "{API_KEY}:" \
      -d "title=New annotation title"
    

    Example Response

    {
      "id":8,
      "object":"annotation",
      "product_id":414646533086276882,
      "title":"New Annotation Title",
      "body":"The long and detailed body of an annotation",
      "timestamp":"2017-12-19T22:01:19.575Z",
      "url":"https://us.z9tracker.com/api/annotations/8"
    }
    

    Updates the title, body, or timestamp. Only the parameters you wish to change need to be specified, the others will remain unchanged.

    Arguments

    Parameter Description
    annotation_id
    required
    The unique identifier of the annotation to be updated
    title
    optional
    The title of the annotation (maximum of 64 characters)
    body
    optional
    The title of the annotation (maximum of 4096 characters)
    timestamp optional The timestamp for the annotation

    Delete an Annotation

    Definition

    DELETE "https://us.z9tracker.com/api/annotations/{ANNOTATION_ID}"
    

    Example Request

    curl -X DELETE "https://us.z9tracker.com/api/annotations/8" \
      -u "{API_KEY}:"
    

    Example Response

    {
      "id":8,
      "deleted":"true"
    }
    

    Permanently deletes an annotation.

    Arguments

    Parameter Description
    annotation_id
    required
    The unique identifier of the annotation to be updated

    List Annotations for a Product

    Definition

    GET "https://us.z9tracker.com/api/products/{PRODUCT_ID}/annotations" \
      -u "{API_KEY}:""
    

    Example Request

    curl -G "https://us.z9tracker.com/api/products/414646533086276882/annotations" \
      -u "{API_KEY}:"
    

    Example Response

    {
      "object":"list",
      "url":"https://us.z9tracker.com/api/products/414646533086276882/annotations",
      "data":[
        {
          "id":7,
          "object":"annotation",
          "product_id":414646533086276882,
          "title":"Annotation Title",
          "body":"The long and detailed body of an annotation",
          "timestamp":"2017-12-19T21:59:53.233Z",
          "url":"https://us.z9tracker.com/api/annotations/7"
        },
        {
          "id":6,
            "object":"annotation",
            "product_id":414646533086276882,
            "title":"Another Annotation Title",
            "body":"The long and detailed body of another annotation",
            "timestamp":"2017-12-19T21:59:51.449Z",
            "url":"https://us.z9tracker.com/api/annotations/6"
        }
      ]
    }
    

    Returns a list of annotations for a specific product. The annotations are returned sorted by timestamp, with the most recent annotation appearing first.

    Arguments

    Parameter Description
    product_id
    required
    Unique identifier for the product for which to return annotations
    limit
    optional
    A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10.

    Keywords

    Keywords are associated with specific products being tracked. The API allows you to create multiple keywords at a time, and delete individual keywords. You can retrieve individual keywords as well as list all of them.

    The Keyword Object

    Example Response

    {
      "id":2665635671922998202,
      "object":"keyword",
      "keyword":"vibration damper for nema 17 motor",
      "url":"https://us.z9tracker.com/api/products/414646533086276882/keywords/2665635671922998202"
    }
    

    Attributes

    Attribute Description
    id
    integer
    Unique identifier for the keyword
    object
    string, value is "keyword"
    String representing the object's type. Objects of the same type share the same value.
    keyword
    string
    The keyword
    url
    string
    Endpoint URL for this object

    Create a Keyword

    Definition

    POST "https://us.z9tracker.com/api/products/{PRODUCT_ID}/keywords"
    

    Example Request

    curl -X POST "https://us.z9tracker.com/api/products/414646533086276882/keywords" -u "{API_KEY}:" \
      -d "keywords=new keyword,another new keyword"
    

    Example Response

    {
      "object":"list",
      "url":"https://us.z9tracker.com/api/products/414646533086276882/keywords",
      "data":[
        {
          "id":2770356251755183944,
          "object":"keyword",
          "keyword":"new keyword",
          "url":"https://us.z9tracker.com/api/products/414646533086276882/keywords/2770356251755183944"
        },
        {
          "id":1629976519369994181,
          "object":"keyword",
          "keyword":"another new keyword",
          "url":"https://us.z9tracker.com/api/products/414646533086276882/keywords/1629976519369994181"
        }
      ]
    }
    

    Creates one or more new keywords for rank tracking. Keyword creation requests are deduplicative .. that is if you create the same keyword for the same product twice, it will not add it a second time.

    Arguments

    Parameter Description
    product_id
    required
    The unique identifier of the product
    keywords
    required
    A comma-separated list of keywords to add to rank tracking for the given product

    Retrieve a Keyword

    Definition

    GET "https://us.z9tracker.com/api/products/{PRODUCT_ID}/keywords/{KEYWORD_ID}"
    

    Example Request

    curl -G "https://us.z9tracker.com/api/products/414646533086276882/keywords/2665635671922998202" \
      -u "{API_KEY}:"
    

    Example Response

    {
      "id":2665635671922998202,
      "object":"keyword",
      "keyword":"vibration damper for nema 17 motor",
      "url":"https://us.z9tracker.com/api/products/414646533086276882/keywords/2665635671922998202"
    }
    

    Retrieves the details of a keyword.

    Arguments

    Parameter Description
    product_id
    required
    The unique identifier of the product
    keyword_id
    required
    The unique identifier of the keyword

    Delete a Keyword

    Definition

    DELETE "https://us.z9tracker.com/api/products/{PRODUCT_ID}/keywords/{KEYWORD_ID}"
    

    Example Request

    curl -X DELETE "https://us.z9tracker.com/api/products/414646533086276882/keywords/2665635671922998202" \
      -u "{API_KEY}:"
    

    Example Response

    {
      "id":2665635671922998202,
      "deleted":"true"
    }
    

    Remove a keyword from tracking in a given product.

    Arguments

    Parameter Description
    product_id
    required
    The unique identifier of the product
    keyword_id
    required
    The unique identifier of the keyword

    List Keywords for a Product

    Definition

    GET "https://us.z9tracker.com/api/products/{PRODUCT_ID}/keywords" \
      -u "{API_KEY}:""
    

    Example Request

    curl -G "https://us.z9tracker.com/api/products/414646533086276882/keywords" \
      -u "{API_KEY}:"
    

    Example Response

    {
      "object":"list",
      "url":"https://us.z9tracker.com/api/products/414646533086276882/keywords",
      "data":[
        {
          "id":4491277083411598576,
          "object":"keyword",
          "keyword":"3d printer motor damper",
          "url":"https://us.z9tracker.com/api/products/414646533086276882/keywords/4491277083411598576"
        },
        {
          "id":174934417645116781,
          "object":"keyword",
          "keyword":"3d printer vibration damper",
          "url":"https://us.z9tracker.com/api/products/414646533086276882/keywords/174934417645116781"
        }
      ]
    }
    

    Returns a list of tracked keywords for a specific product. The keywords are returned sorted in alphabetical order

    Arguments

    Parameter Description
    product_id
    required
    Unique identifier for the product for which to return keywords

    Timeseries

    Much of the interaction with the API will be retrieving timeseries data such as as a series of prices, best seller rankings, keyword rankings, etc. Each request is limited to a maximum of 1000 data points and the default is to return just the most recent one.

    The Timeseries Object

    Example Response:

    {
      "object":"timeseries",
      "product_id":414646533086276882,
      "series":"bsr",
      "label":"Best Seller Ranking",
      "dimension":"rank",
      "department":{
        "id":4,
        "object":"department",
        "name":"3D Printer Parts & Accessories",
        "label":"Industrial & Scientific : Additive Manufacturing Products : 3D Printer Parts & Accessories"
      },
      "url":"https://us.z9tracker.com/api/products/414646533086276882/bsr/4",
      "data":[
        ["2017-12-12T22:50:51.514Z",16],
        ["2017-12-12T21:01:09.058Z",16],
        ["2017-12-12T00:13:35.098Z",18],
        ["2017-12-11T23:13:31.882Z",18],
        ["2017-12-11T22:55:25.750Z",18]
      ]
    }
    

    Timeseries are returned with a product, a series, a department, and an array of timeseries data. Each timeseries supports a number of filters that allow you to restrict the number of fields retrieved.

    Attributes

    Parameter Description
    product_id
    integer
    Unique identifier for the product
    object
    string, value is "timeseries"
    String representing the object's type. Objects of the same type share the same value.
    series
    string
    Type of timeseries, could be one of bsr, price, keyword, ratings, or reviews
    label
    string
    String representing the label for this series, eg. Best Seller Ranking, Price, or a specific keyword you are looking at
    dimension
    string
    Type of timeseries such as rank, price, count, or rating
    department
    hash
    Department for which this timeseries is generated
    keyword
    string
    Keyword for which this timeseries is generated (not always present)
    url
    string
    Endpoint url for this timeseries
    data
    list
    An list of [time, value] data for this timeseries

    Timeseries Filtering

    Example Timestamp

    2017-12-25T18:25:00Z
    

    It is best practice to only retrieve as much data as you need, not the entire data set every time. For this reason, the default limit is 1, or just the most recent data point. Additionally, you can filter on the starting or ending times which is useful for pagination or retrieving data during a specific timeframe. Times can be given in a number of formats but for most consistent results, use ISO 8601 formatting.

    Parameters for Every Time Series

    Parameter Description
    limit
    optional
    Limit the number of data points returned. The maximum is 1000 and the default is 1.
    after
    optional
    Only return data points that occur after this timestamp
    before
    optional
    Only return data points that occur before this timestamp

    Best Seller Rankings

    Definition

    GET "https://us.z9tracker.com/api/products/{PRODUCT_ID}/bsr/{DEPARTMENT_ID}"
    

    Example Request

    curl -G "https://us.z9tracker.com/api/products/414646533086276882/bsr/4?limit=5" \
      -u "{API_KEY}:"
    
    {
      "object":"timeseries",
      "product_id":414646533086276882,
      "series":"bsr",
      "label":"Best Seller Ranking",
      "dimension":"rank",
      "department":{
        "id":4,
        "object":"department",
        "name":"3D Printer Parts & Accessories",
        "label":"Industrial & Scientific : Additive Manufacturing Products : 3D Printer Parts & Accessories"
      },
      "url":"https://us.z9tracker.com/api/products/414646533086276882/bsr/4",
      "data":[
        ["2017-12-12T22:50:51.514Z",16],
        ["2017-12-12T21:01:09.058Z",16],
        ["2017-12-12T00:13:35.098Z",18],
        ["2017-12-11T23:13:31.882Z",18],
        ["2017-12-11T22:55:25.750Z",18]
      ]
    }
    

    Retrieve timeseries data for the Best Seller Ranking. This method takes all of the filtering parameters available for all timeseries queries

    Parameter Description
    product_id
    required
    Unique identifier of the product for which to retrieve data
    department_id
    required
    Unique identified of the department

    Keyword Rankings

    Definition

    GET "https://us.z9tracker.com/api/products/{PRODUCT_ID}/keyword_rankings/{DEPARTMENT_ID}/{KEYWORD_ID}"
    

    Example Request

    curl -G "https://us.z9tracker.com/api/products/414646533086276882/keyword_rankings/2/4491277083411598576" \
      -u "{API_KEY}:" -d "limit=3"
    
    {
      "object":"timeseries",
      "product_id":414646533086276882,
      "series":"Keyword Ranking",
      "dimension":"rank",
      "keyword":{
        "id":4491277083411598576,
        "object":"keyword",
        "keyword":"3d printer motor damper",
        "url":"https://us.z9tracker.com/api/products/414646533086276882/keywords/4491277083411598576"
      },
      "department":{
        "id":2,
        "object":"department",
        "name":"Industrial & Scientific",
        "label":"Industrial & Scientific"
      },
      "url":"https://us.z9tracker.com/api/products/414646533086276882/keyword_rankings/2/4491277083411598576",
      "data":[
        ["2017-12-12T22:08:38Z",1],
        ["2017-12-12T22:05:33Z",1],
        ["2017-12-12T22:04:06Z",1]
      ]
    }
    

    Retrieve timeseries data for Keyword Rankings. This method takes all of the filtering parameters available for all timeseries queries

    Parameter Description
    product_id
    required
    Unique identifier of the product for which to retrieve data
    department_id
    required
    Unique identifier of the department
    keyword_id
    required
    Unique identifier of the keyword

    Price History

    Definition

    GET "https://us.z9tracker.com/api/products/{PRODUCT_ID}/prices"
    

    Example Request

    curl -G "https://us.z9tracker.com/api/products/414646533086276882/prices?limit=2" \
      -u "{API_KEY}:"
    
    {
      "object":"timeseries",
      "product_id":414646533086276882,
      "series":"Price",
      "dimension":"price",
      "department":null,
      "url":"https://us.z9tracker.com/api/products/414646533086276882/price",
      "data":[
        ["2017-12-12T22:50:51Z",13.27],
        ["2017-12-12T21:01:09Z",13.27]
      ]
    }
    

    Retrieve timeseries data for an ASIN's price history. This method takes all of the filtering parameters available for all timeseries queries. The department attribute will always be null for this query as the data is not department-specific.

    Parameter Description
    product_id
    required
    Unique identifier of the product for which to retrieve data

    Review History

    Definition

    GET "https://us.z9tracker.com/api/products/{PRODUCT_ID}/reviews"
    

    Example Request

    curl -G "https://us.z9tracker.com/api/products/414646533086276882/reviews?limit=2" \
      -u "{API_KEY}:"
    
    {
      "object":"timeseries",
      "product_id":414646533086276882,
      "series":"Number of Reviews",
      "dimension":"reviews",
      "department":null,
      "url":"https://us.z9tracker.com/api/products/414646533086276882/reviews",
      "data":[
        ["2017-12-12T00:00:00Z",11],
        ["2017-12-11T00:00:00Z",10]
      ]
    }
    

    Retrieve timeseries data for an ASIN's review history. The number of reviews are only stored daily as they are not subject to change that much over time. This method takes all of the filtering parameters available for all timeseries queries. The department attribute will always be null for this query as the data is not department-specific.

    Parameter Description
    product_id
    required
    Unique identifier of the product for which to retrieve data

    Ratings History

    Definition

    GET "https://us.z9tracker.com/api/products/{PRODUCT_ID}/ratings"
    

    Example Request

    curl -G "https://us.z9tracker.com/api/products/414646533086276882/ratings?limit=2" \
      -u "{API_KEY}:"
    
    {
      "object":"timeseries",
      "product_id":414646533086276882,
      "series":"Average Rating",
      "dimension":"rating",
      "department":null,
      "url":"https://us.z9tracker.com/api/products/414646533086276882/ratings",
      "data":[
        ["2017-12-12T00:00:00Z",5.0],
        ["2017-12-11T00:00:00Z",5.0]
      ]
    }
    

    Retrieve timeseries data for an ASIN's average rating. Ratings are only stored daily as they are not subject to change that much over time. This method takes all of the filtering parameters available for all timeseries queries. The department attribute will always be null for this query as the data is not department-specific.

    Parameter Description
    product_id
    required
    Unique identifier of the product for which to retrieve data

    Errors

    The Z9 Tracker API uses the following error codes:

    Error Code Meaning
    401 Unauthorized -- Your API key is wrong.
    404 Not Found -- The specified resource could not be found.
    406 Not Acceptable -- You requested a format that isn't json.
    429 Too Many Requests -- Too many requests, please slow down.
    500 Internal Server Error -- We had a problem with our server. Try again later.
    503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.