Client Feeds End Points

Client Feed Queue Endpoint

  • Endpoint: https://api.hootinteractive.net/cli_api/feed/queue/<feed_request_id>

  • Security: HTTPS Basic Auth

    • User: <client_id>

    • Pass: <token>

  • Allowed Calls:

    • GET: Obtains status of the client feed request.

    • DELETE: Deletes the feed request:

    • POST: Creates a feed request:

      • Params:

        • feed(required): Feed type. Here are the currently supported feed types:

          • 'sold': All vehicles that were removed from the inventory on a given day.

          • 'inventory': All Inventory data from a given day.

          • 'adversion': Currently active Video Ad Versions.

        • date(optional): If it is not present it defaults to the last day with data for each advertiser. If set to today, it will return an empty file(the first date with data is yesterday).

      • Responses:

        • 500 + Error message in case of error

        • 404 If feed type is not supported

        • 200 OK

      • Request Body example:

        1 2 3 4 { "feed": "sold", "date": "2021-12-28" }

Feed Request Status Object

1 2 3 4 5 6 7 8 9 10 { "id":1, # ID of feed Request "created": "2021-12-25 00:00:00", # Creation date of the request "updated": "2021-12-25 00:00:00", # Last update date of the request "client_id":1, # Target client of the feed "feed":"sold", # Feed type: ["sold","inventory","adversion"] "date":"2021-15-25", # Date target of the feed "status":"queued", # Status : ["queued","running", "error", "ready"] "error":null # Error message if something went wrong when creating the feed }

 Edit

Client Feed Download