Quividi VidiCenter API

https://vidicenter-api.readthedocs.io/en/master/
Admin
The Quividi VidiCenter API is a RESTful web service that allows customers to access and export...
Tokens:24,102
Snippets:173
Trust Score:9.6
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET /sites/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/topology.rst.txt

Returns a list of your sites.

```APIDOC
## GET https://vidicenter.quividi.com/api/v1/sites/

### Description
Returns a list of your sites.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/sites/

### Response
#### Success Response (200)
- **network_id** (integer) - Associated network ID
- **id** (integer) - Site ID
- **label** (string) - Site name
- **active** (boolean) - Status of the site
- **address** (string) - Site address
- **venue_type** (string) - Type of venue
```

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

### GET /networks/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/topology.rst.txt

Returns a list of your networks.

```APIDOC
## GET https://vidicenter.quividi.com/api/v1/networks/

### Description
Returns a list of your networks.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/networks/

### Response
#### Success Response (200)
- **id** (integer) - Network ID
- **label** (string) - Network name
- **active** (boolean) - Status of the network
```

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

### GET /api/v1/zones/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/topology.rst.txt

Returns a list of zones from your locations.

```APIDOC
## GET /api/v1/zones/

### Description
Returns a list of zones from your locations.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/zones/
```

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

### POST /api/v1/oem/register/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/oem.rst.txt

Registers a player installation with VidiCenter to enable Quividi audience measurement.

```APIDOC
## POST /api/v1/oem/register/

### Description
Registers a player installation with VidiCenter. This call is typically made from the vendor's backend to tie a player to a VidiReports installation.

### Method
POST

### Endpoint
https://vidicenter.quividi.com/api/v1/oem/register/

### Parameters
#### Request Body
- **vendor_id** (string) - Required - The vendor id
- **vendor_player_id** (string) - Required - The player id
- **vendor_network_id** (string) - Required - An arbitrary identifier for the network to which this player belongs

### Response
#### Success Response (200)
- **status** (string) - Returns "ok" on success

#### Error Response (400)
- **status** (string) - Returns "error" on failure
- **reason** (string) - A human-readable description of the error

### Response Example
{
    "status": "ok"
}
```

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

### GET /api/v1/boxes/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/topology.rst.txt

Returns a list of all boxes available to the user.

```APIDOC
## GET /api/v1/boxes/

### Description
Returns a list of your boxes.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/boxes/
```

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

### GET /sites/vehicles/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/topology.rst.txt

Returns a list of your sites including vehicle factors.

```APIDOC
## GET https://vidicenter.quividi.com/api/v1/sites/vehicles/

### Description
Returns a list of your sites with vehicles factors.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/sites/vehicles/

### Response
#### Success Response (200)
- **id** (integer) - Site ID
- **label** (string) - Site name
- **active** (boolean) - Status of the site
- **network_id** (integer) - Associated network ID
- **vehicles_factors** (object) - Object containing vehicle factors (factor_car, factor_van, factor_bus, factor_truck)
```

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

### GET /api/v1/chart/

Source: https://vidicenter-api.readthedocs.io/en/master/chart.html

Generates a chart based on specified network parameters.

```APIDOC
## GET /api/v1/chart/

### Description
Generates a chart for a specific network. The output can be returned as an image or raw data.

### Method
GET

### Endpoint
/api/v1/chart/

### Parameters
#### Query Parameters
- **chart_type** (integer) - Required - The type of chart to generate.
- **chart_period** (string) - Required - The time period for the chart (e.g., week).
- **chart_format** (string) - Required - The format of the response (image or json).
- **network_id** (integer) - Required - The ID of the network.
```

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

### Handle authentication error

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/general_usage.rst.txt

Example of an error response when an invalid token is provided.

```bash
$> curl -u USERNAME:INVALID_TOKEN https://vidicenter.quividi.com/api/v1/whoami/
{"message": "Invalid API Token", "error": 401}
```

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

### GET /api/v1/site_tags/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/tags.rst.txt

Returns a list of your site tags.

```APIDOC
## GET /api/v1/site_tags/

### Description
Returns a list of your site tags.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/site_tags/

### Response
#### Success Response (200)
- **network_id** (integer) - The network ID.
- **id** (integer) - The tag ID.
- **label** (string) - The tag label.
- **extrapolation** (boolean) - Read-only flag marking the tag as locked for extrapolation purposes.
```

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

### Retrieve all zones

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/topology.rst.txt

Example of a cURL request to fetch all zones across locations.

```bash
curl -u USERNAME:AUTH_TOKEN https://vidicenter.quividi.com/api/v1/zones/
```

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

### GET https://vidicenter.quividi.com/api/v1/sites/

Source: https://vidicenter-api.readthedocs.io/en/master/topology.html

Retrieves a list of all sites associated with the user account.

```APIDOC
## GET https://vidicenter.quividi.com/api/v1/sites/

### Description
Returns a list of your sites.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/sites/

### Response
#### Success Response (200)
- **network_id** (integer) - ID of the parent network
- **id** (integer) - Unique identifier for the site
- **label** (string) - Name of the site
- **active** (boolean) - Status of the site
- **address** (string) - Physical address of the site
- **black_input_is_error** (boolean) - Configuration flag
- **daily_watchers_alert_threshold** (integer) - Alert threshold value
- **description** (string) - Site description
- **exclude_from_network_vrc** (boolean) - Configuration flag
- **ignore_low_fps** (boolean) - Configuration flag
- **max_active_locations** (integer) - Maximum active locations allowed
- **upload_period_alert** (integer) - Alert period in minutes
- **venue_subtype** (string) - Subtype of the venue
- **venue_type** (string) - Type of the venue

#### Response Example
[
    {
        "network_id": 15678,
        "id": 8654,
        "label": "VidiReports",
        "active": true,
        "address": "12 Main Street",
        "black_input_is_error": true,
        "daily_watchers_alert_threshold": 0,
        "description": "VEHICULOS",
        "exclude_from_network_vrc": false,
        "ignore_low_fps": false,
        "max_active_locations": 0,
        "upload_period_alert": 780,
        "venue_subtype": "Bowling Center",
        "venue_type": "Entertainment / hospitality"
    }
]
```

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

### GET /api/v1/sites/vehicles/

Source: https://vidicenter-api.readthedocs.io/en/master/topology.html

Returns a list of your sites with their associated vehicles factors.

```APIDOC
## GET /api/v1/sites/vehicles/

### Description
Returns a list of your sites with vehicles factors.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/sites/vehicles/

### Response
#### Success Response (200)
- **id** (integer) - Site ID
- **label** (string) - Site label
- **active** (boolean) - Site status
- **network_id** (integer) - Network ID
- **vehicles_factors** (object) - Vehicle factor multipliers

#### Response Example
[
    {
        "id": 4200,
        "label": "My only site",
        "active": true,
        "network_id": 567,
        "vehicles_factors": {
            "factor_car": 1.6,
            "factor_van": 3.5,
            "factor_bus": 9.5,
            "factor_truck": 1.2
        }
    }
]
```

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

### OEM API Response Examples

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/oem.rst.txt

JSON response structures for successful and failed registration attempts.

```json
{
    "status": "ok"
}
```

```json
{
    "status": "error",
    "reason": "Missing 'vendor_id' in request"
}
```

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

### GET https://vidicenter.quividi.com/api/v1/clip/metadata/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/clip_metadata.rst.txt

Retrieves a list of all Clip Metadata.

```APIDOC
## GET https://vidicenter.quividi.com/api/v1/clip/metadata/

### Description
Returns a list of your Clip Metadata.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/clip/metadata/

### Response
#### Success Response (200)
- **Array** (list) - A list of clip metadata objects.
```

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

### Create Clip Metadata

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/clip_metadata.rst.txt

Examples demonstrating successful creation, handling of duplicate clip IDs, and validation errors for missing mandatory fields.

```bash
curl -u USERNAME:AUTH_TOKEN --form "screenshot=@path/to/local/image.jpg;filename=desired-filename-in-vidicenter.jpg" --form clip_id="clip_123" --form network=9876 --form name="My clip name" --form description="The description of my clip" --form clip_duration=10 --form advertiser_name "My favorite advertiser" https://vidicenter.quividi.com/api/v1/clip/metadata/
{
    "url": "https://vidicenter.quividi.com/api/v1/network/9876/clip/metadata/clip_123/"
}
```

```bash
curl -u USERNAME:AUTH_TOKEN --form clip_id="clip_123" --form network=9876 --form name="Another clip name" https://vidicenter.quividi.com/api/v1/clip/metadata/
> Response has a 400 status code with message: "Clip metadata with this Clip id and Network already exists"
```

```bash
curl -u USERNAME:AUTH_TOKEN --form clip_id="clip_456" --form network=9876 https://vidicenter.quividi.com/api/v1/clip/metadata/
> Response has a 400 status code with message: "name: This field is required"
```

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

### GET https://vidicenter.quividi.com/api/v1/networks/

Source: https://vidicenter-api.readthedocs.io/en/master/topology.html

Retrieves a list of all networks associated with the user account.

```APIDOC
## GET https://vidicenter.quividi.com/api/v1/networks/

### Description
Returns a list of your networks.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/networks/

### Response
#### Success Response (200)
- **id** (integer) - Unique identifier for the network
- **label** (string) - Name of the network
- **active** (boolean) - Status of the network

#### Response Example
[
    {
        "id": 15678,
        "label": "My first network",
        "active": true
    },
    {
        "id": 25444,
        "label": "My other network",
        "active": false
    }
]
```

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

### Create Clip Metadata via cURL

Source: https://vidicenter-api.readthedocs.io/en/master/clip_metadata.html

Example of a successful POST request to create clip metadata including an image upload.

```bash
curl -u USERNAME:AUTH_TOKEN --form "screenshot=@path/to/local/image.jpg;filename=desired-filename-in-vidicenter.jpg" --form clip_id="clip_123" --form network=9876 --form name="My clip name" --form description="The description of my clip" --form clip_duration=10 --form advertiser_name "My favorite advertiser" https://vidicenter.quividi.com/api/v1/clip/metadata/
{
    "url": "https://vidicenter.quividi.com/api/v1/network/9876/clip/metadata/clip_123/"
}
```

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

### GET https://vidicenter.quividi.com/api/v1/locations/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/topology.rst.txt

Returns a list of all locations associated with the authenticated user.

```APIDOC
## GET https://vidicenter.quividi.com/api/v1/locations/

### Description
Returns a list of your locations.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/locations/

### Response
#### Success Response (200)
- **last_timezone** (integer) - Timezone offset in seconds to UTC.
- **last_seen** (string) - Last timestamp when the location was in contact with vidicenter.
- **last_upload_timestamp** (string) - Last timestamp when the location uploaded data.
- **last_ots_uploaded** (string) - Last timestamp when the location uploaded OTS events.
- **id_pointer** (string) - Optional pointer id to a different location.
- **id_broadsign_displayunitid** (string) - Optional BroadSign display unit ID.
- **id_broadsign_playerid** (string) - Optional BroadSign player ID.
- **id_broadsign_screenid_v1** (string) - Optional BroadSign screen ID.
- **id_broadsign_uuid** (string) - Optional BroadSign UUID.
- **location_type** (string) - Type describing this location.
- **venue_type** (string) - Venue type of the site.
- **venue_subtype** (string) - Venue subtype of the site.
- **description** (string) - Free-text description of the location.
- **bm_ignore** (boolean) - Whether this location is excluded from benchmarks.
```

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

### GET /network/{network_id}/sites/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/topology.rst.txt

Returns a list of a specific network's sites.

```APIDOC
## GET https://vidicenter.quividi.com/api/v1/network/{network_id}/sites/

### Description
Returns a list of a network's sites.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/network/{network_id}/sites/

### Parameters
#### Path Parameters
- **network_id** (integer) - Required - The ID of the network

### Response
#### Success Response (200)
- **network_id** (integer) - Associated network ID
- **id** (integer) - Site ID
- **label** (string) - Site name
- **active** (boolean) - Status of the site
```

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

### GET https://vidicenter.quividi.com/api/v1/alerts/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/status.rst.txt

Returns a list of the 1000 most recent alerts in your networks.

```APIDOC
## GET https://vidicenter.quividi.com/api/v1/alerts/

### Description
Returns a list of the 1000 most recent alerts in your networks.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/alerts/

### Parameters
#### Query Parameters
- **active** (boolean) - Optional - If specified as True, only the currently active alerts will be returned.
- **hours** (integer) - Optional - An integer value between 1 and 24, returns only alerts from the last X hours (limited to 1000 maximum).

### Response
#### Success Response (200)
- **alert_type** (numeric) - Identifier representing the type of alert.
- **label** (string) - Type of the alert.
- **status** (string) - Status of the alert ("raised" or "terminated").
- **extra_data** (string) - Additional info for specific alert types.
- **linked_alerthistory** (integer) - Unique identifier of the alert the current alert is terminating.
```

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

### GET /api/v1/network/{network_id}/sites/

Source: https://vidicenter-api.readthedocs.io/en/master/topology.html

Returns a list of sites belonging to a specific network.

```APIDOC
## GET /api/v1/network/{network_id}/sites/

### Description
Returns a list of a network’s sites.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/network/{network_id}/sites/

### Parameters
#### Path Parameters
- **network_id** (integer) - Required - The ID of the network

### Response
#### Success Response (200)
- **network_id** (integer) - Network ID
- **id** (integer) - Site ID
- **label** (string) - Site label
- **active** (boolean) - Site status

#### Response Example
[
    {
        "network_id": 15678,
        "id": 8654,
        "label": "VidiReports",
        "active": true
    }
]
```

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

### GET /api/v1/network/{network_id}/site_tags/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/tags.rst.txt

Returns a list of a network's site tags.

```APIDOC
## GET /api/v1/network/{network_id}/site_tags/

### Description
Returns a list of a network's site tags.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/network/{network_id}/site_tags/

### Parameters
#### Path Parameters
- **network_id** (integer) - Required - The ID of the network.
```

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

### Save Chart Image via cURL

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/chart.rst.txt

Example of saving a binary PNG chart response to a local file.

```bash
curl -u USERNAME:AUTH_TOKEN 'https://vidicenter.quividi.com/api/v1/chart/?chart_type=4&chart_period=week&chart_format=image&network_id=123' > mychart.png
```

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

### GET /api/v1/network/{network_id}/boxes/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/topology.rst.txt

Returns a list of boxes associated with a specific network.

```APIDOC
## GET /api/v1/network/{network_id}/boxes/

### Description
Returns a list of a network's boxes.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/network/{network_id}/boxes/

### Parameters
#### Path Parameters
- **network_id** (integer) - Required - The network identifier.
```

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

### GET /site/{site_id}/boxes/

Source: https://vidicenter-api.readthedocs.io/en/master/topology.html

Returns a list of boxes associated with a specific site.

```APIDOC
## GET https://vidicenter.quividi.com/api/v1/site/{site_id}/boxes/

### Description
Returns a list of a site’s boxes.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/site/{site_id}/boxes/

### Parameters
#### Path Parameters
- **site_id** (integer) - Required - The unique identifier of the site.

### Response
#### Success Response (200)
- **last_upload_timestamp** (string) - Timestamp of the last upload.
- **location_id** (integer) - ID of the location.
- **site_id** (integer) - ID of the site.
- **id** (integer) - ID of the box.
- **label** (string) - Label of the box.
- **active** (boolean) - Status of the box.
- **box_mac** (integer) - MAC address of the box.
- **raw_camera_config** (string) - Camera configuration string.
```

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

### POST https://vidicenter.quividi.com/api/v1/oem/register/

Source: https://vidicenter-api.readthedocs.io/en/master/oem.html

Registers a player installation with VidiCenter to enable Quividi audience measurement.

```APIDOC
## POST https://vidicenter.quividi.com/api/v1/oem/register/

### Description
Registers a player installation with VidiCenter. This endpoint is typically called from the vendor's backend to tie a player to VidiReports.

### Method
POST

### Endpoint
https://vidicenter.quividi.com/api/v1/oem/register/

### Parameters
#### Request Body
- **vendor_id** (string) - Required - The vendor id
- **vendor_player_id** (string) - Required - The player id
- **vendor_network_id** (string) - Required - An arbitrary identifier for the network to which this player belongs

### Response
#### Success Response (200)
- **status** (string) - Returns "ok" on success

#### Failure Response (400)
- **status** (string) - Returns "error" on failure
- **reason** (string) - A human-readable description of the error

### Response Examples
Success:
{
    "status": "ok"
}

Failure:
{
    "status": "error",
    "reason": "Missing 'vendor_id' in request"
}
```

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

### GET /api/v1/site/{site_id}/boxes/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/topology.rst.txt

Returns a list of boxes associated with a specific site.

```APIDOC
## GET /api/v1/site/{site_id}/boxes/

### Description
Returns a list of a site's boxes.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/site/{site_id}/boxes/

### Parameters
#### Path Parameters
- **site_id** (integer) - Required - The unique identifier of the site.

### Response
#### Success Response (200)
- **last_upload_timestamp** (string) - Last upload timestamp
- **location_id** (integer) - Location ID
- **site_id** (integer) - Site ID
- **id** (integer) - Box ID
- **label** (string) - Box label
- **active** (boolean) - Active status
- **box_mac** (integer) - Box MAC address
- **raw_camera_config** (string) - Camera configuration string
```

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

### Retrieve Monitoring Messages via cURL

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/status.rst.txt

Example request and response structure for fetching monitoring messages using cURL with authentication.

```bash
curl -u USERNAME:AUTH_TOKEN https://vidicenter.quividi.com/api/v1/monitoring_msgs/
[
    {
        "avg_luma": "43.1%",
        "box": 1742,
        "cpu_load": 27,
        "fps": "27.8",
        "location": 1982,
        "nb_inputlost": 0,
        "raw_camera_config": "rtsp://***:***@192.168.0.50:554/stream1",
        "resolution": "800x600",
        "status": "running",
        "host_timestamp": "2015-10-27T11:00:00",
        "timestamp": "2015-10-27T12:02:25",
        "vr_status": "Processing",
        "vr_version": "VidiReports v7.7.4.7"
    },
    {
        "avg_luma": "100.0%",
        "box": 1582,
        "cpu_load": 22,
        "fps": "-",
        "location": 1692,
        "nb_inputlost": 0,
        "raw_camera_config": "",
        "resolution": "0x0",
        "status": "running",
        "host_timestamp": "2015-10-27T12:00:00",
        "timestamp": "2015-10-27T12:29:25",
        "vr_status": "Input Lost",
        "vr_version": "VidiReports v7.7.5.1"
    }
]
```

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

### GET /api/v1/site_tag/{tag}/boxes/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/topology.rst.txt

Returns a list of boxes associated with a specific site tag.

```APIDOC
## GET /api/v1/site_tag/{tag}/boxes/

### Description
Returns a list of a site tag's boxes.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/site_tag/{tag}/boxes/

### Parameters
#### Path Parameters
- **tag** (string) - Required - The site tag name.
```

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

### GET /network/{network_id}/sites/vehicles/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/topology.rst.txt

Returns a list of a specific network's sites with vehicle factors.

```APIDOC
## GET https://vidicenter.quividi.com/api/v1/network/{network_id}/sites/vehicles/

### Description
Returns a list of a network's sites with vehicles factors.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/network/{network_id}/sites/vehicles/

### Parameters
#### Path Parameters
- **network_id** (integer) - Required - The ID of the network

### Response
#### Success Response (200)
- **id** (integer) - Site ID
- **label** (string) - Site name
- **active** (boolean) - Status of the site
- **network_id** (integer) - Associated network ID
- **vehicles_factors** (object) - Object containing vehicle factors
```

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

### GET /api/v1/network/{network_id}/sites/vehicles/

Source: https://vidicenter-api.readthedocs.io/en/master/topology.html

Returns a list of sites for a specific network including their vehicle factors.

```APIDOC
## GET /api/v1/network/{network_id}/sites/vehicles/

### Description
Returns a list of a network’s sites with vehicles factors.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/network/{network_id}/sites/vehicles/

### Parameters
#### Path Parameters
- **network_id** (integer) - Required - The ID of the network

### Response
#### Success Response (200)
- **id** (integer) - Site ID
- **label** (string) - Site label
- **active** (boolean) - Site status
- **network_id** (integer) - Network ID
- **vehicles_factors** (object) - Vehicle factor multipliers

#### Response Example
[
    {
        "id": 4200,
        "label": "My only site",
        "active": true,
        "network_id": 567,
        "vehicles_factors": {
            "factor_car": 1.6,
            "factor_van": 3.5,
            "factor_bus": 9.5,
            "factor_truck": 1.2
        }
    }
]
```

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

### GET https://vidicenter.quividi.com/api/v1/site/{site_id}/locations/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/topology.rst.txt

Returns a list of locations belonging to a specific site.

```APIDOC
## GET https://vidicenter.quividi.com/api/v1/site/{site_id}/locations/

### Description
Returns a list of a site's locations.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/site/{site_id}/locations/

### Parameters
#### Path Parameters
- **site_id** (integer) - Required - The ID of the site.
```

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

### Retrieve Chart Data via cURL

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/chart.rst.txt

Example of fetching chart data in JSON format using cURL authentication.

```bash
curl -u USERNAME:AUTH_TOKEN 'https://vidicenter.quividi.com/api/v1/chart/?chart_type=4&chart_period=week&chart_format=json&network_id=123'
{
  "metric": {
    "0": "Watchers",
    "1": "Watchers",
    "2": "Watchers",
    "3": "Watchers",
    "4": "Watchers",
    "5": "Watchers",
    "6": "Watchers",
    "7": "Watchers",
    "8": "Impressions",
    "9": "Impressions",
    "10": "Impressions",
    "11": "Impressions",
    "12": "Impressions",
    "13": "Impressions",
    "14": "Impressions",
    "15": "Impressions"
  },
  "date": {
    "0": "2022-01-25",
    "1": "2022-01-26",
    "2": "2022-01-27",
    "3": "2022-01-28",
    "4": "2022-01-29",
    "5": "2022-01-30",
    "6": "2022-01-31",
    "7": "2022-02-01",
    "8": "2022-01-25",
    "9": "2022-01-26",
    "10": "2022-01-27",
    "11": "2022-01-28",
    "12": "2022-01-29",
    "13": "2022-01-30",
    "14": "2022-01-31",
    "15": "2022-02-01"
  },
  "count": {
    "0": 139820,
    "1": 145918,
    "2": 149832,
    "3": 214979,
    "4": 380036,
    "5": 239112,
    "6": 160306,
    "7": 168189,
    "8": 620973,
    "9": 647391,
    "10": 675640,
    "11": 1058382,
    "12": 1723385,
    "13": 1116993,
    "14": 691686,
    "15": 747844
  }
}
```

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

### GET /site_tag/{tag}/boxes/

Source: https://vidicenter-api.readthedocs.io/en/master/topology.html

Returns a list of boxes associated with a specific site tag.

```APIDOC
## GET https://vidicenter.quividi.com/api/v1/site_tag/{tag}/boxes/

### Description
Returns a list of a site tag’s boxes.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/site_tag/{tag}/boxes/

### Parameters
#### Path Parameters
- **tag** (string) - Required - The site tag name.
```

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

### GET https://vidicenter.quividi.com/api/v1/network/{network_id}/locations/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/topology.rst.txt

Returns a list of locations belonging to a specific network.

```APIDOC
## GET https://vidicenter.quividi.com/api/v1/network/{network_id}/locations/

### Description
Returns a list of a network's locations.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/network/{network_id}/locations/

### Parameters
#### Path Parameters
- **network_id** (integer) - Required - The ID of the network.
```

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

### Advanced Chart API Requests

Source: https://vidicenter-api.readthedocs.io/en/master/chart.html

Examples for requesting advanced charts in JSON or image format using cURL.

```bash
curl -u USERNAME:AUTH_TOKEN "https://vidicenter.quividi.com/api/v1/adv_chart/?chart_type=0&chart_format=json&start=2025-04-01&end=2025-04-14&auto_select_locations=1&clip_ids=my_clip1,my_clip2"
```

```bash
curl -u USERNAME:AUTH_TOKEN "https://vidicenter.quividi.com/api/v1/adv_chart/?chart_type=0&chart_format=image&start=2025-04-01&end=2025-04-14&auto_select_locations=1&clip_ids=my_clip1,my_clip2" > output.png
```

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

### GET /site/{site_id}/alerts/

Source: https://vidicenter-api.readthedocs.io/en/master/status.html

Returns a list of a site’s 1000 most recent alerts.

```APIDOC
## GET https://vidicenter.quividi.com/api/v1/site/{site_id}/alerts/

### Description
Returns a list of a site’s 1000 most recent alerts.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/site/{site_id}/alerts/

### Parameters
#### Path Parameters
- **site_id** (string) - Required - The unique identifier of the site.

#### Query Parameters
- **active** (boolean) - Optional - If specified as True, only the currently active alerts will be returned.
- **hours** (integer) - Optional - An integer value between 1 and 24, returns only alerts from the last X hours.
```

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

### GET https://vidicenter.quividi.com/api/v1/network/{network_id}/clip/metadata/{clip_id}/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/clip_metadata.rst.txt

Retrieves details for a specific Clip Metadata.

```APIDOC
## GET https://vidicenter.quividi.com/api/v1/network/{network_id}/clip/metadata/{clip_id}/

### Description
Returns information about a specific Clip Metadata.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/network/{network_id}/clip/metadata/{clip_id}/

### Parameters
#### Path Parameters
- **network_id** (integer) - Required - The network ID.
- **clip_id** (string) - Required - The clip ID.

### Response
#### Success Response (200)
- **description** (string) - Description of the clip.
- **screenshot** (string) - URL to the screenshot.
- **network_id** (integer) - The network ID.
- **clip_id** (string) - The clip ID.
- **id** (integer) - Internal ID.
- **name** (string) - Name of the clip.
```

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

### GET https://vidicenter.quividi.com/api/v1/site/{site_id}/alerts/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/status.rst.txt

Returns a list of a site's 1000 most recent alerts.

```APIDOC
## GET https://vidicenter.quividi.com/api/v1/site/{site_id}/alerts/

### Description
Returns a list of a site's 1000 most recent alerts.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/site/{site_id}/alerts/

### Parameters
#### Path Parameters
- **site_id** (string) - Required - The unique identifier of the site.

#### Query Parameters
- **active** (boolean) - Optional - If specified as True, only the currently active alerts will be returned.
- **hours** (integer) - Optional - An integer value between 1 and 24, returns only alerts from the last X hours (limited to 1000 maximum).
```

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

### GET https://vidicenter.quividi.com/api/v1/adv_chart/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/chart.rst.txt

Retrieves an advanced chart based on specific date ranges and location or site identifiers.

```APIDOC
## GET https://vidicenter.quividi.com/api/v1/adv_chart/

### Description
Retrieves an advanced chart. Requires specific permissions.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/adv_chart/

### Parameters
#### Query Parameters
- **chart_type** (integer) - Required - The type of chart (0: Dwell & Attention).
- **start** (string) - Required - Start date (YYYY-MM-DD).
- **end** (string) - Required - End date (YYYY-MM-DD).
- **chart_format** (string) - Required - The response format (image, json).
- **locations** (string) - Optional - Comma separated location IDs.
- **sites** (string) - Optional - Comma separated site IDs.

### Response
#### Success Response (200)
- **binary/json** - Returns a PNG image or JSON object.
```

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

### GET https://vidicenter.quividi.com/api/v1/network/{network_id}/alerts/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/status.rst.txt

Returns a list of a network's 1000 most recent alerts.

```APIDOC
## GET https://vidicenter.quividi.com/api/v1/network/{network_id}/alerts/

### Description
Returns a list of a network's 1000 most recent alerts.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/network/{network_id}/alerts/

### Parameters
#### Path Parameters
- **network_id** (string) - Required - The unique identifier of the network.

#### Query Parameters
- **active** (boolean) - Optional - If specified as True, only the currently active alerts will be returned.
- **hours** (integer) - Optional - An integer value between 1 and 24, returns only alerts from the last X hours (limited to 1000 maximum).
```

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

### GET /api/v1/adv_chart/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/chart.rst.txt

Retrieves an advanced chart for specified clips, supporting JSON data or binary image output.

```APIDOC
## GET /api/v1/adv_chart/

### Description
Generates a chart based on provided clip IDs and date ranges. Supports automatic location selection and various output formats.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/adv_chart/

### Parameters
#### Query Parameters
- **chart_type** (integer) - Required - The type of chart to generate.
- **chart_format** (string) - Required - The output format, either 'json' or 'image'.
- **start** (string) - Required - Start date in YYYY-MM-DD format.
- **end** (string) - Required - End date in YYYY-MM-DD format.
- **auto_select_locations** (integer) - Optional - Set to 1 to automatically select locations that played the provided clips.
- **clip_ids** (string) - Mandatory if auto_select_locations is provided - Comma-separated list of clip IDs. Replace commas with %252C.
- **content_duration** (integer) - Optional - Content duration in seconds (10, 20, or 60). Defaults to 10.

### Request Example
curl -u USERNAME:AUTH_TOKEN "https://vidicenter.quividi.com/api/v1/adv_chart/?chart_type=0&chart_format=json&start=2025-04-01&end=2025-04-14&auto_select_locations=1&clip_ids=my_clip1,my_clip2"

### Response
#### Success Response (200)
- **auto_select_locations** (array) - List of automatically selected location IDs (returned if format is JSON).
- **content_duration** (object) - Mapping of duration segments.
- **metric** (object) - Mapping of metric types.
- **seconds** (object) - Mapping of metric values per segment.
```

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

### GET https://vidicenter.quividi.com/api/v1/chart/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/chart.rst.txt

Retrieves a predefined chart based on the specified type, period, and network or vendor identifiers.

```APIDOC
## GET https://vidicenter.quividi.com/api/v1/chart/

### Description
Retrieves a predefined chart. The response can be a binary PNG image or raw JSON data.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/chart/

### Parameters
#### Query Parameters
- **chart_type** (integer) - Required - The type of chart to generate (0-8).
- **chart_period** (string) - Required - The period (day, week, month).
- **chart_format** (string) - Required - The response format (image, json).
- **network_id** (integer) - Optional - ID of the network.
- **vendor_id** (integer) - Optional - ID of the vendor.
- **vendor_network_id** (integer) - Optional - ID of the vendor network.

### Response
#### Success Response (200)
- **binary/json** - Returns a PNG image or JSON object containing metric, date, and count data.
```

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

### GET /api/v1/location_tags/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/tags.rst.txt

Returns a list of your location tags.

```APIDOC
## GET /api/v1/location_tags/

### Description
Returns a list of your location tags.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/location_tags/
```

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

### Retrieve Sites List

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/topology.rst.txt

Fetches a list of all sites associated with the authenticated user.

```bash
curl -u USERNAME:AUTH_TOKEN https://vidicenter.quividi.com/api/v1/sites/
[
    {
        "network_id":15678,
        "id":8654,
        "label":"VidiReports",
        "active":true,
        "address": "12 Main Street",
        "black_input_is_error": true,
        "daily_watchers_alert_threshold": 0,
        "description": "VEHICULOS",
        "exclude_from_network_vrc": false,
        "ignore_low_fps": false,
        "max_active_locations": 0,
        "upload_period_alert": 780,
        "venue_subtype": "Bowling Center",
        "venue_type": "Entertainment / hospitality"
    },
    {
        "network_id":15678,
        "id":54422,
        "label":"Another site",
        "active":true,
        "address": "",
        "black_input_is_error": true,
        "daily_watchers_alert_threshold": 0,
        "description": "",
        "exclude_from_network_vrc": false,
        "ignore_low_fps": false,
        "max_active_locations": 0,
        "upload_period_alert": 780,
        "venue_subtype": "Bowling Center",
        "venue_type": "Entertainment / hospitality"
    },
    {
        "network_id":25444,
        "id":66531,
        "label":"VidiReports",
        "active":false,
        "address": "",
        "black_input_is_error": true,
        "daily_watchers_alert_threshold": 0,
        "description": "",
        "exclude_from_network_vrc": false,
        "ignore_low_fps": false,
        "max_active_locations": 0,
        "upload_period_alert": 780,
        "venue_subtype": "Bowling Center",
        "venue_type": "Entertainment / hospitality"
    }
]
```

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

### GET /api/v1/locations/

Source: https://vidicenter-api.readthedocs.io/en/master/topology.html

Retrieves a list of all locations associated with the user account.

```APIDOC
## GET /api/v1/locations/

### Description
Returns a list of all locations available to the user.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/locations/

### Response
#### Success Response (200)
- **last_upload_timestamp** (string) - Last timestamp when the location uploaded data.
- **last_timezone** (integer) - Timezone offset in seconds to UTC.
- **box_id** (integer) - The box ID associated with the location.
- **site_id** (integer) - The site ID associated with the location.
- **id** (integer) - The location ID.
- **label** (string) - The label of the location.
- **description** (string) - Free-text description of the location.
- **bm_ignore** (boolean) - Whether this location is excluded from benchmarks.
- **active** (boolean) - Whether the location is active.
```

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

### Test authentication token

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/general_usage.rst.txt

Verify your credentials by querying the whoami endpoint.

```bash
$> curl -u USERNAME:AUTH_TOKEN https://vidicenter.quividi.com/api/v1/whoami/
{"username": "USERNAME"}
```

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

### POST /api/v1/clip/metadata/

Source: https://vidicenter-api.readthedocs.io/en/master/clip_metadata.html

Creates a new Clip Metadata entry and returns the API URL for the created resource.

```APIDOC
## POST /api/v1/clip/metadata/

### Description
Creates a new Clip Metadata entry. This endpoint is used to associate metadata with a specific clip ID within a network.

### Method
POST

### Endpoint
https://vidicenter.quividi.com/api/v1/clip/metadata/

### Parameters
#### Request Body (Form Data)
- **clip_id** (string) - Required - The clip id linked to the metadata.
- **network** (integer) - Required - The network’s id in which the clip is used.
- **name** (string) - Required - The name of the clip (Max 64 characters).
- **clip_duration** (float) - Optional - Duration in seconds (0-999, up to 2 decimal places).
- **advertiser_name** (string) - Optional - Advertiser name (Max 255 characters).
- **description** (string) - Optional - Description of the clip.
- **screenshot** (file) - Optional - An image for the clip.
- **video** (file) - Optional - A video file for the clip.
- **creative_agency_name** (string) - Optional - Creative agency name (Max 255 characters).

### Request Example
curl -u USERNAME:AUTH_TOKEN --form "screenshot=@path/to/local/image.jpg" --form clip_id="clip_123" --form network=9876 --form name="My clip name" https://vidicenter.quividi.com/api/v1/clip/metadata/

### Response
#### Success Response (200)
- **url** (string) - The API URL of the created metadata resource.

#### Response Example
{
    "url": "https://vidicenter.quividi.com/api/v1/network/9876/clip/metadata/clip_123/"
}
```

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

### Authenticate with curl

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/general_usage.rst.txt

Use HTTP Basic Auth with your username and token for every request.

```bash
$> curl -u USERNAME:AUTH_TOKEN https://vidicenter.quividi.com/api/.../
```

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

### GET /api/v1/monitoring_msgs/

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/status.rst.txt

Returns a list of your 1000 most recent monitoring messages.

```APIDOC
## GET /api/v1/monitoring_msgs/

### Description
Returns a list of your 1000 most recent monitoring messages.

### Method
GET

### Endpoint
https://vidicenter.quividi.com/api/v1/monitoring_msgs/

### Parameters
#### Query Parameters
- **hours** (integer) - Optional - Returns monitoring messages from the last X hours (1-24).
```

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

### Check LANG environment variable

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/clip_metadata.rst.txt

Verify that the system locale is set to UTF-8 to support unicode data uploads.

```bash
echo $LANG
en_US.UTF-8
```

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

### Retrieve Sites with Vehicles Factors

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/topology.rst.txt

Fetches a list of sites including their specific vehicle factors.

```bash
curl -u USERNAME:AUTH_TOKEN https://vidicenter.quividi.com/api/v1/sites/vehicles/
[
    {
        "id": 4200,
        "label": "My only site",
        "active": true,
        "network_id": 567,
        "vehicles_factors": {
            "factor_car": 1.6,
            "factor_van": 3.5,
            "factor_bus": 9.5,
            "factor_truck": 1.2
        }
    }
]
```

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

### Retrieve Network's Sites with Vehicles Factors

Source: https://vidicenter-api.readthedocs.io/en/master/_sources/topology.rst.txt

Fetches a list of sites for a specific network, including vehicle factors.

```bash
curl -u USERNAME:AUTH_TOKEN https://vidicenter.quividi.com/api/v1/network/567/sites/vehicles/
[
    {
        "id": 4200,
        "label": "My only site",
        "active": true,
        "network_id": 567,
        "vehicles_factors": {
            "factor_car": 1.6,
            "factor_van": 3.5,
            "factor_bus": 9.5,
            "factor_truck": 1.2
        }
    }
]
```
Tokens:
Raw