Skip to main content

Managing reports

A report is a data analysis that determines a single key performance indicator (KPI) or a list of KPIs. The data base for this analysis is an export of raw data at regular intervals. This data is saved on a secure cloud storage.

1. Raw data

Raw data is collected in the background, usually over night. The raw data to be saved is set in the Setup » plentyBI » Raw data menu. You can retrieve the generated files via the REST API and process the data externally.

1.1. For end users

We have observed that business decisions are often not made based on key figures, but rather intuitively. In order to change this behaviour, we recommend using a business intelligence tool. Ideally, such a toll analyses different data from several sources. This allows you to identify specific recommendations for action. Start now and use our integrated plentyBI dashboard to keep track of relevant data and key figures. Further information is available in the plentyBI section of the manual.

1.2. For developers

Raw data is available in CSV format and can therefore easily be processed. All plentymarkets systems have a standardised REST API. You can find the documentation on this page .

Raw data is retrieved in two steps. We recommend retrieving the data once a day after around noon. At this point, the process of generating raw data is completed for all systems.

First, a list of available raw data files is retrieved via this route . The time at which the latest file of the last retrieval was created serves as a filter for the next retrieval. In this way, the files are not retrieved several times. The number of files that are generated per day may vary depending on how many creator processes are activated for a plentymarkets system. Furthermore, only a certain number of data rows is written in each file. If required, another file is created. With this route, either all files of a single creator or all files that were created during the retrieval interval are exported. With this route , a raw data file is exported. The required file path is contained in the sample space of the REST route listed in point 1. Raw data files are provided as a GZIP-compressed CSV file (RFC 1952). A comma is used as column separator.

Standard time stamp format

The standard date format is MM/DD/YYYY HH:MI:SS TZ. This date format can be copied directly to an AWS Redshift column of the type TIMESTAMPTZ. Example: 01/30/2019 05:14:57 Europe/Berlin

1.3. Data format creator

The creator is a specific process that provides a raw data format. Each creator only saves data after you have activated the creator in the Setup » plentyBI » Raw data menu.

For explanations and links to individual format pages, see Table 1.

Limited saving of raw data

In plentymarkets, raw data are the data basis for the key figures available in the plentyBI module. Depending on the plentyBI tariff that was booked, raw data are saved for different periods of time in the system. In general,the following periods apply:

  • plentyBI XS: 3 months

  • plentyBI S: 6 months

  • plentyBI M: 12 months

  • plentyBI L: 48 months

More detailed information for each raw data format can be accessed by clicking on the links in Table 1.

Table 1. Available raw data formats
Data format Explanation

accountContacts

Contact
For further information, see the accountContacts page.

accounts

Company
For further information, see the accounts page.

categories

Categories
For further information, see the categories page.

feedbacks

Feedbacks
For further information, see the feedbacks page.

itemManufacturer

Manufacturer
For further information, see the itemManufacturer page.

itemVariations

Variation
For further information, see the ItemVariations page.

itemVariationSuppliers

Links between suppliers and variations
For further information, see the itemVariationSuppliers page.

marketplaceStockMovement

Stock information that was exported to specific markets
For further information, see the marketplaceStockMovement page.

messages

Messages
For further information, see the messages page.

messageTagRelations

Tag relations of messages
For further information, see the messageTagRelations page.

orderDocuments

Order documents
For further information, see the orderDocuments page.

orderItemAmounts

Number of order items
For further information, see the orderItemAmounts page.

orderItemProperties

Property of the order item
For further information, see the orderItemProperties page.

orderItems

Order item
For further information, see the orderItems page.

orderProperties

Order property
For further information, see the orderProperties page.

orders

Order
For further information, see the orders page.

orderStatuses

Order status
For further information, see the orderStatuses page.

paymentOrderRelations

Links between payments and orders
For further information, see the paymentOrderRelations page.

payments

Payments
For further information, see the payments page.

properties

Properties
For further information, see the properties page.

propertyRelations

Links between properties and other data
For further information, see the propertyRelations page.

stockManagementStock

Stock
For further information, see the stockManagementStock page.

stockManagementStockMovements

Stock movements
For further information, see the stockManagementStockMovements page.

stockManagementWarehouses

Warehouses
For further information, see the stockManagementWarehouses page.

tags

Tags
For further information, see the tags page.

tagRelations

Tag links
For further information, see the tagRelations page.

users

Users
For further information, see the users page.

variationValidation

Variations that have been exported to markets but have been rejected
For further information, see the marketplaceVariationValidation page.

More data formats will be added to this table as they become available.

To top