### API Authentication Example Source: https://app.dealavo.com/api/v3/docs Example URL demonstrating how to authenticate API requests using account ID and API key. ```url https://app.dealavo.com/api/v3/updates?account_id=&api_key= ``` -------------------------------- ### Default Request Payload Example Source: https://app.dealavo.com/api/v3/docs This example shows a basic request payload for the first page of data with default settings. ```json { "columns": "all", "settings": { "csv_delimiter": ";", "nested_data_separator": ",", "page": 1 } } ``` -------------------------------- ### Generate Report - Select All Columns Source: https://app.dealavo.com/api/v3/docs Example JSON payload for generating a report, requesting all available columns. ```json { "columns": "all" } ``` -------------------------------- ### Get Available Columns Response Sample Source: https://app.dealavo.com/api/v3/docs Sample JSON response for the 'Get available columns' endpoint, listing all possible columns for reports. ```json { "columns": [ "Id", "Article", "Retailer", "Retailer offer name", "Retailer price", "Retailer price with shipping", "Availability", "Wholesale price", "Source", "Labels", "Price", "Price with shipping", "Url", "Crossed out price", "Previous price", "Original price", "Currency", "Vat", "Brand", "Catalogue Price", "Maximum Price", "Minimum Price", "Stock", "EAN", "Producer", "Product code", "Promotion description", "Url" ] } ``` -------------------------------- ### Get Update Dates Response Sample Source: https://app.dealavo.com/api/v3/docs Sample JSON response for the 'Get update dates' endpoint, listing available update dates. ```json { "update_dates": [ "2024_02_28_06_00", "2024_02_22_12_00" ] } ``` -------------------------------- ### Example CSV Report Response Source: https://app.dealavo.com/api/v3/docs A sample CSV response including columns like 'Id', 'Retailer', 'Retailer price', 'Availability', 'Source', 'Price', and 'Update time'. ```csv Id;Retailer;Retailer price;Availability;Source;Price;Update time 1182986505;eshop;5.3;Available, in assortment;source file;5.3;2024_03_13_11_00 1182986505;sklep.pl (allegro.pl);6.99;Unavailable, in assortment;Allegro;5.3;2024_03_13_11_00 # Additional rows... ``` -------------------------------- ### Generate Report - Select Specific Columns Source: https://app.dealavo.com/api/v3/docs Example JSON payload for generating a report, specifying a subset of columns to include. ```json { "columns": ["Id", "Labels"] } ``` -------------------------------- ### Get Available Columns Source: https://app.dealavo.com/api/v3/docs Provides a complete list of columns available for use in report data. These column names can be used when making API queries. ```APIDOC ## Get available columns ### Description This endpoint provides a complete list of columns available to the client within the report data. The returned list includes column names that can be used when making API queries, offering flexibility in customizing reports to individual needs. ### Method GET ### Endpoint /api/v3/columns ### Parameters #### Query Parameters - **account_id** (string) - Required - Your account identifier. - **api_key** (string) - Required - Your API key for authentication. ### Responses #### Success Response (200) - **columns** (array) - A list of strings, where each string is an available column name. ### Response Example ```json { "columns": [ "Id", "Article", "Retailer", "Retailer offer name", "Retailer price", "Retailer price with shipping", "Availability", "Wholesale price", "Source", "Labels", "Price", "Price with shipping", "Url", "Crossed out price", "Previous price", "Original price", "Currency", "Vat", "Brand", "Catalogue Price", "Maximum Price", "Minimum Price", "Stock", "EAN", "Producer", "Product code", "Promotion description", "Url" ] } ``` ``` -------------------------------- ### Get Update Dates Source: https://app.dealavo.com/api/v3/docs Retrieves a list of dates when data updates occurred. Each date is formatted as YYYY_MM_DD_HH_MM. ```APIDOC ## Get update dates ### Description This endpoint returns a list of dates when data updates occurred. Each date is formatted as `YYYY_MM_DD_HH_MM`, allowing easy identification of the specific update moment. ### Method GET ### Endpoint /api/v3/updates ### Parameters #### Query Parameters - **account_id** (string) - Required - Your account identifier. - **api_key** (string) - Required - Your API key for authentication. ### Responses #### Success Response (200) - **update_dates** (array) - A list of strings, where each string represents a date and time of an update in `YYYY_MM_DD_HH_MM` format. ### Response Example ```json { "update_dates": [ "2024_02_28_06_00", "2024_02_22_12_00" ] } ``` ``` -------------------------------- ### Generate a Report Source: https://app.dealavo.com/api/v3/docs Allows generating reports with configurable options, including user-specified columns. The 'Update time' column is always included. ```APIDOC ## Generate a report ### Description Allows generating reports with configurable options. Users can specify which columns should be included in the report. The "Update time" column is always included in the results, and the order of columns in the returned CSV matches the order specified in the request. ### Method POST ### Endpoint /api/v3/report ### Parameters #### Query Parameters - **account_id** (string) - Required - Your account identifier. - **api_key** (string) - Required - Your API key for authentication. #### Request Body - **columns** (array or string) - Required - Specifies the columns to include. Can be an array of column names (e.g., `["Id", "Labels"]`) or the string `"all"` to include all available columns. ### Request Example ```json { "columns": ["Id", "Labels"] } ``` ### Request Example (All Columns) ```json { "columns": "all" } ``` ### Responses #### Success Response (200) - The response will be a CSV file containing the requested data with the specified columns. #### Error Response (429) - **Too Many Requests**: Returned if the rate limit is exceeded. ``` -------------------------------- ### Specify Data Range for Report Source: https://app.dealavo.com/api/v3/docs Use 'start_date' and 'end_date' to define the data range for the report. Dates must be in 'YYYY_MM_DD_HH_MM' format. If not specified, the last update date is used. ```json { "columns": "all", "start_date": "2024_01_01_10_00", "end_date": "2024_01_31_23_00", "settings": { "csv_delimiter": ";", "nested_data_separator": ",", "page": 1 } } ``` -------------------------------- ### Generate Report in JSON Format Source: https://app.dealavo.com/api/v3/docs To receive reports in JSON format, set 'format' to 'json' within the 'settings'. JSON reports include 'columns', 'data', and 'next_page' fields. ```json { "columns": [ "Id", "Article", "Retailer", "Retailer offer name" ], "next_page": 2, "data": [ [ "1182986505", "Animonda GranCarno Original Adult wołowina i jagnięcina 400g", "test_dev_front", "Animonda GranCarno Original Adult wołowina i jagnięcina 400g" ], [ "1182986505", "Animonda GranCarno Original Adult wołowina i jagnięcina 400g", "kingofprice (allegro.pl)", "Animonda GranCarno 400g adult Wołowina Pur" ] ] } ``` -------------------------------- ### Generate Report Source: https://app.dealavo.com/api/v3/docs This endpoint allows you to generate reports with customizable data ranges, settings, and formats. You can specify columns, date ranges, and various settings like CSV delimiters or pagination. ```APIDOC ## POST /api/v3/report ### Description Generates a report with specified columns, date range, and settings. Supports CSV and JSON formats. ### Method POST ### Endpoint https://app.dealavo.com/api/v3/report ### Parameters #### Request Body schema: application/json - **columns** (string or Array of strings) - Required - Columns to include in the report - **start_date** (string) - Optional - Start date in the format 'YYYY_MM_DD_HH_MM' - **end_date** (string) - Optional - End date in the format 'YYYY_MM_DD_HH_MM' - **settings** (object) - Optional - Configuration for report settings - **csv_delimiter** (string) - Optional - A single character used as the column separator. By default, it is set to `;`. - **nested_data_separator** (string) - Optional - The separator used for values in columns that are lists. By default, it is a comma `,`. - **page** (integer) - Optional - The page number for data, defaulting to 1. - **number_of_offers_per_page** (integer) - Optional - The number of rows with offers per page. By default, it is set to 10,000. The maximum number of rows in a single request is 20,000. - **only_available_offers** (boolean) - Optional - A flag indicating whether the report should include only currently available offers. By default, it is set to `false`. - **format** (string) - Optional - The report format. Can be `csv` (default) or `json`. ### Request Example ```json { "columns": "all", "start_date": "2024_01_01_10_00", "end_date": "2024_01_31_23_00", "settings": { "csv_delimiter": ";", "nested_data_separator": ",", "page": 1, "format": "json" } } ``` ### Responses #### Success Response (200) - **columns** (Array of strings) - A list of column names included in the report (for JSON format). - **data** (Array of Arrays) - The report data presented as a list of lists (for JSON format). - **next_page** (integer or null) - Number of the next available page or null if current page is the last one (for JSON format). #### Response Example (JSON) ```json { "columns": [ "Id", "Article", "Retailer", "Retailer offer name" ], "next_page": 2, "data": [ [ "1182986505", "Animonda GranCarno Original Adult wołowina i jagnięcina 400g", "test_dev_front", "Animonda GranCarno Original Adult wołowina i jagnięcina 400g" ], [ "1182986505", "Animonda GranCarno Original Adult wołowina i jagnięcina 400g", "kingofprice (allegro.pl)", "Animonda GranCarno 400g adult Wołowina Pur" ] ] } ``` #### Response Example (CSV) ```csv Id;Retailer;Retailer price;Availability;Source;Price;Update time 1182986505;eshop;5.3;Available, in assortment;source file;5.3;2024_03_13_11_00 1182986505;sklep.pl (allegro.pl);6.99;Unavailable, in assortment;Allegro;5.3;2024_03_13_11_00 ``` #### Error Responses - **400** Bad Request - **404** Not Found - **429** Too Many Requests ``` -------------------------------- ### Configure CSV Delimiter Source: https://app.dealavo.com/api/v3/docs Set the 'csv_delimiter' in the settings to customize the column separator for CSV reports. The default is ';'. ```csv Id;Availability;Update time 8591022201428;Unavailable, in assortment;2024_03_13_11_00 ``` -------------------------------- ### Configure Nested Data Separator Source: https://app.dealavo.com/api/v3/docs Use 'nested_data_separator' to define the delimiter for values within list-type columns, such as group labels. The default is ','. ```csv Id;Labels;Update time 8591022201428;Happy green|promocja|single;2024_03_13_11_00 ``` -------------------------------- ### Handle Commas in CSV Data Source: https://app.dealavo.com/api/v3/docs When using a comma as a delimiter, enclose fields containing commas in quotation marks. Empty strings are also enclosed in quotation marks. ```csv Id,Availability,Update time 8591022201428,"Unavailable, in assortment",2024_03_13_11_00 ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.