RetailNext

https://retailnext.atlassian.net/wiki/spaces/PUBLICDOCS/
Admin
RetailNext is a retail analytics platform that provides traffic counting, occupancy monitoring, POS...
Tokens:66,416
Snippets:533
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### POST /v2/datamine - Mixed Date Range Options

Source: https://retailnext.atlassian.net/wiki/spaces/PUBLICDOCS/pages/174817482/API

Demonstrates using a combination of different date range options (Gregorian, Absolute, Relative) within the same request.

```APIDOC
## POST /v2/datamine

### Description
Allows using a mix of any two date range options (Gregorian, Absolute, Relative) in 'from' and 'to' specifications.

### Method
POST

### Endpoint
https://<subscription>.api.retailnext.net/v2/datamine

### Parameters
#### Request Body
- **date_ranges** (array) - Required - An array of date range objects.
  - **from** (object) - Required - The start of the date range. Can use Gregorian, Absolute, or Relative options.
  - **to** (object) - Required - The end of the date range. Can use Gregorian, Absolute, or Relative options.

### Request Example
```json
{
  "date_ranges": [
    {
      "from": {
        "gregorian": "2021-02-27T00:00:00Z"
      },
      "to": {
        "relative": {
          "add_days": 7
        }
      }
    }
  ]
}
```

### Response
#### Success Response (200)
- **serverDuration** (integer) - The duration of the server processing.
- **requestCorrelationId** (string) - A unique identifier for the request.

#### Response Example
```json
{
  "serverDuration": 25,
  "requestCorrelationId": "8edbd928696d47739aab2bf3befca929"
}
```
```

--------------------------------

### POST /v2/datamine - Absolute Date Range

Source: https://retailnext.atlassian.net/wiki/spaces/PUBLICDOCS/pages/174817482/API

Specifies a date range using absolute date components like year, week, day, hour, etc.

```APIDOC
## POST /v2/datamine

### Description
Allows specifying date ranges using absolute date components.

### Method
POST

### Endpoint
https://<subscription>.api.retailnext.net/v2/datamine

### Parameters
#### Request Body
- **date_ranges** (array) - Required - An array of date range objects.
  - **from** (object) - Required - The start of the date range.
    - **absolute** (object) - Required - Absolute date components.
      - **year** (integer) - Required - Calendar year.
      - **quarter** (integer) - Optional - Calendar quarter (1-4).
      - **month** (integer) - Optional - Calendar month (1-12).
      - **week** (integer) - Optional - Calendar week (1-53).
      - **day** (integer) - Optional - Calendar day (1-31).
      - **hour** (integer) - Optional - Hour (0-23).
      - **minute** (integer) - Optional - Minute (0-59).
      - **second** (integer) - Optional - Second (0-59).
  - **to** (object) - Required - The end of the date range.
    - **absolute** (object) - Required - Absolute date components.
      - **year** (integer) - Required - Calendar year.
      - **quarter** (integer) - Optional - Calendar quarter (1-4).
      - **month** (integer) - Optional - Calendar month (1-12).
      - **week** (integer) - Optional - Calendar week (1-53).
      - **day** (integer) - Optional - Calendar day (1-31).
      - **hour** (integer) - Optional - Hour (0-23).
      - **minute** (integer) - Optional - Minute (0-59).
      - **second** (integer) - Optional - Second (0-59).

### Request Example
```json
{
  "date_ranges": [
    {
      "from": {
        "absolute": {
          "year": 2021,
          "week": 2,
          "day": 4
        }
      },
      "to": {
        "absolute": {
          "year": 2021,
          "week": 3
        }
      }
    }
  ]
}
```

### Response
#### Success Response (200)
- **serverDuration** (integer) - The duration of the server processing.
- **requestCorrelationId** (string) - A unique identifier for the request.

#### Response Example
```json
{
  "serverDuration": 25,
  "requestCorrelationId": "8edbd928696d47739aab2bf3befca929"
}
```
```

--------------------------------

### POST /v2/datamine - Relative Date Range

Source: https://retailnext.atlassian.net/wiki/spaces/PUBLICDOCS/pages/174817482/API

Specifies a date range using relative date calculations based on a base date or other date range parameters.

```APIDOC
## POST /v2/datamine

### Description
Allows specifying date ranges using relative date calculations.

### Method
POST

### Endpoint
https://<subscription>.api.retailnext.net/v2/datamine

### Parameters
#### Request Body
- **date_ranges** (array) - Required - An array of date range objects.
  - **from** (object) - Required - The start of the date range.
    - **relative** (object) - Required - Relative date components.
      - **base** (object) - Required if both 'from' and 'to' are relative. Any valid date option (e.g., gregorian, absolute).
      - **truncate_to** (string) - Optional - Interval to truncate the base date to (year, quarter, month, week, day, hour, minute, second).
      - **add_years** (integer) - Optional - Number of years to add.
      - **add_quarters** (integer) - Optional - Number of quarters to add.
      - **add_months** (integer) - Optional - Number of months to add.
      - **add_weeks** (integer) - Optional - Number of weeks to add.
      - **add_days** (integer) - Optional - Number of days to add.
      - **add_hours** (integer) - Optional - Number of hours to add.
      - **add_minutes** (integer) - Optional - Number of minutes to add.
      - **add_seconds** (integer) - Optional - Number of seconds to add.
  - **to** (object) - Required - The end of the date range.
    - **relative** (object) - Required - Relative date components (same structure as 'from.relative').

### Request Example
```json
{
  "date_ranges": [
    {
      "from": {
        "relative": {
          "base": {
            "gregorian": "2021-02-27T00:00:00Z"
          }
        }
      },
      "to": {
        "relative": {
          "add_days": 5
        }
      }
    }
  ]
}
```

### Response
#### Success Response (200)
- **serverDuration** (integer) - The duration of the server processing.
- **requestCorrelationId** (string) - A unique identifier for the request.

#### Response Example
```json
{
  "serverDuration": 25,
  "requestCorrelationId": "8edbd928696d47739aab2bf3befca929"
}
```
```
Tokens:
Raw