Skip to main content
Skip table of contents

General client configurations

General client configurations

General information Request to obtain basic project settings.

The intercom_call_events and external_events keys will be present in the response only if the user has access to these properties. If latitude, longitude, zoom keys in section map_coordinates return value null, then values not installed

GET /api/v1/static

200 OK

Returns a list of information available to the user

Click here to expand...
CODE
{
  "notification": {
    "text": "Some notification",
    "is_force": true
  },
  "mark_types": [
    {
      "name": "mark",
      "description": "Label"
    },
    {
      "name": "external_event",
      "description": "External Events"
    },
    {
      "name": "motion_detect_smtp",
      "description": "Detection of SMTP traffic"
    },
    {
      "name": "face-recognized",
      "description": "Person identified"
    },
    {
      "name": "face-unrecognized",
      "description": "Person not identified"
    },
    {
      "name": "person-counting",
      "description": "Count objects in an area"
    },
    {
      "name": "motion_detect",
      "description": "Zone Intrusion Detection"
    },
    {
      "name": "licplate-recognized",
      "description": "License plate identified"
    },
    {
      "name": "licplate-unrecognized",
      "description": "License plate unidentified"
    },
    {
      "name": "visitors-counting",
      "description": "People Counting"
    },
    {
      "name": "camera-obstacle",
      "description": "Damage detection"
    }
  ],
  "camera_issues": [
    {
      "id": 1,
      "title": "Foreign objects in the lens"
    },
    {
      "id": 2,
      "title": "No sound"
    },
    {
      "id": 3,
      "title": "No image"
    },
    {
      "id": 4,
      "title": "Operation interruptions"
    },
    {
      "id": 5,
      "title": "The rotating mechanism is faulty"
    }
  ],
  "analytic_issues": [
    {
      "id": 13,
      "title": "Analytics events are not arriving. The analytics stream is active"
    },
    {
      "id": 14,
      "title": "Analytics events are not arriving. The analytics stream is inactive"
    }
  ],
  "layout_templates": [
    {
      "id": 1,
      "name": "Grid11",
      "count": 1,
      "created_at": "2021-05-27 15:43:36",
      "updated_at": "2021-05-27 15:43:36"
    },
    {
      "id": 2,
      "name": "Grid21",
      "count": 2,
      "created_at": "2021-05-27 15:43:36",
      "updated_at": "2021-05-27 15:43:36"
    },
    {
      "id": 3,
      "name": "Grid22",
      "count": 2,
      "created_at": "2021-05-27 15:43:36",
      "updated_at": "2021-05-27 15:43:36"
    },
    {
      "id": 4,
      "name": "Grid31",
      "count": 3,
      "created_at": "2021-05-27 15:43:36",
      "updated_at": "2021-05-27 15:43:36"
    },
    {
      "id": 5,
      "name": "Grid41",
      "count": 4,
      "created_at": "2021-05-27 15:43:36",
      "updated_at": "2021-05-27 15:43:36"
    },
    {
      "id": 6,
      "name": "Grid42",
      "count": 4,
      "created_at": "2021-05-27 15:43:36",
      "updated_at": "2021-05-27 15:43:36"
    },
    {
      "id": 7,
      "name": "Grid51",
      "count": 5,
      "created_at": "2021-05-27 15:43:36",
      "updated_at": "2021-05-27 15:43:36"
    },
    {
      "id": 8,
      "name": "Grid61",
      "count": 6,
      "created_at": "2021-05-27 15:43:36",
      "updated_at": "2021-05-27 15:43:36"
    },
    {
      "id": 9,
      "name": "Grid62",
      "count": 6,
      "created_at": "2021-05-27 15:43:36",
      "updated_at": "2021-05-27 15:43:36"
    },
    {
      "id": 10,
      "name": "Grid81",
      "count": 8,
      "created_at": "2021-05-27 15:43:36",
      "updated_at": "2021-05-27 15:43:36"
    },
    {
      "id": 11,
      "name": "Grid91",
      "count": 9,
      "created_at": "2021-05-27 15:43:36",
      "updated_at": "2021-05-27 15:43:36"
    },
    {
      "id": 12,
      "name": "Grid111",
      "count": 11,
      "created_at": "2021-05-27 15:43:36",
      "updated_at": "2021-05-27 15:43:36"
    },
    {
      "id": 13,
      "name": "Grid161",
      "count": 16,
      "created_at": "2021-05-27 15:43:36",
      "updated_at": "2021-05-27 15:43:36"
    }
  ],
  "permissions": [
    {
      "type": "analytic",
      "external_key": "analytic_l3",
      "group": "Analytics level 3",
      "permissions": [
        {
          "id": 51,
          "name": "analytic-cases-face",
          "display_name": "Business Case - Facial Recognition",
          "group": "Analytics Business Cases"
        },
        {
          "id": 58,
          "name": "analytic-cases-license-plate",
          "display_name": "Business case - license plate recognition",
          "group": "Analytics Business Cases"
        }
      ]
    },
    {
      "type": "analytic",
      "external_key": "analytic_l2",
      "group": "Analytics level 2",
      "permissions": [
        {
          "id": 52,
          "name": "analytic-cases-person-counting",
          "display_name": "Business case - counting people in an area",
          "group": "Analytics Business Cases"
        },
        {
          "id": 59,
          "name": "analytic-cases-visitor-counting",
          "display_name": "Business Case - People Counting",
          "group": "Analytics Business Cases"
        }
      ]
    },
    {
      "type": "analytic",
      "external_key": "analytic_l1",
      "group": "Analytics level 1",
      "permissions": [
        {
          "id": 62,
          "name": "analytic-cases-smoke-fire",
          "display_name": "Business case - smoke and fire detection",
          "group": "Analytics Business Cases"
        },
        {
          "id": 63,
          "name": "analytic-cases-line-intersection",
          "display_name": "Business Case - Line Crossing Detection",
          "group": "Analytics Business Cases"
        },
        {
          "id": 61,
          "name": "analytic-cases-loud-sounds",
          "display_name": "Business case - loud sound detection",
          "group": "Analytics Business Cases"
        },
        {
          "id": 57,
          "name": "analytic-cases-motion-detect",
          "display_name": "Business case - zone intrusion detection",
          "group": "Analytics Business Cases"
        },
        {
          "id": 60,
          "name": "analytic-cases-camera-obstacle",
          "display_name": "Business case - camera damage/overlap/vandalism detection",
          "group": "Analytics Business Cases"
        }
      ]
    },
    {
      "type": null,
      "external_key": null,
      "group": "Analytics Business Cases",
      "permissions": [
        {
          "id": 50,
          "name": "analytic-cases-index",
          "display_name": "List of business cases",
          "group": "Analytics Business Cases"
        }
      ]
    },
    {
      "type": null,
      "external_key": null,
      "group": "Analytics Resources",
      "permissions": [
        {
          "id": 43,
          "name": "analytic-files-destroy",
          "display_name": "Deleting a resource"
        },
        {
          "id": 39,
          "name": "analytic-files-index",
          "display_name": "View Resources"
        },
        {
          "id": 41,
          "name": "analytic-files-show",
          "display_name": "View Resource"
        },
        {
          "id": 40,
          "name": "analytic-files-store",
          "display_name": "Creating Resource"
        },
        {
          "id": 42,
          "name": "analytic-files-update",
          "display_name": "Resource Update"
        }
      ]
    },
    {
      "type": null,
      "external_key": null,
      "group": "Analytics Resource Groups",
      "permissions": [
        {
          "id": 48,
          "name": "analytic-groups-destroy",
          "display_name": "Deleting a resource group"
        },
        {
          "id": 44,
          "name": "analytic-groups-index",
          "display_name": "View Resource Groups"
        },
        {
          "id": 46,
          "name": "analytic-groups-show",
          "display_name": "Display Resource Group"
        },
        {
          "id": 45,
          "name": "analytic-groups-store",
          "display_name": "Creating a Resource Group"
        },
        {
          "id": 47,
          "name": "analytic-groups-update",
          "display_name": "Resource Group Update"
        }
      ]
    },
    {
      "type": null,
      "external_key": null,
      "group": "License statistics",
      "permissions": [
        {
          "id": 261,
          "name": "analytic-license-index",
          "display_name": "Business Case License Statistics"
        }
      ]
    },
    {
      "type": null,
      "external_key": null,
      "group": "Archive",
      "permissions": [
        {
          "id": 19,
          "name": "archives-download",
          "display_name": "Saving camera archive"
        },
        {
          "id": 18,
          "name": "archives-show",
          "display_name": "View Archive"
        }
      ]
    },
    {
      "type": null,
      "external_key": null,
      "group": "Screenshots",
      "permissions": [
        {
          "id": 20,
          "name": "archives-preview-download",
          "display_name": "Saving camera screenshot"
        }
      ]
    },
    {
      "type": null,
      "external_key": null,
      "group": "Events",
      "permissions": [
        {
          "id": 22,
          "name": "camera-events-index",
          "display_name": "Camera Event Viewer"
        }
      ]
    },
    {
      "type": null,
      "external_key": null,
      "group": "Camera groups",
      "permissions": [
        {
          "id": 16,
          "name": "groups-cameras-attach",
          "display_name": "Adding a camera to a folder"
        },
        {
          "id": 17,
          "name": "groups-cameras-detach",
          "display_name": "Removing a camera from a folder"
        },
        {
          "id": 14,
          "name": "groups-destroy",
          "display_name": "Deleting a folder"
        },
        {
          "id": 15,
          "name": "groups-rename",
          "display_name": "Rename folder"
        },
        {
          "id": 13,
          "name": "groups-store",
          "display_name": "Creating Folder"
        }
      ]
    },
    {
      "type": null,
      "external_key": null,
      "group": "Intercom",
      "permissions": [
        {
          "id": 235,
          "name": "intercom-index",
          "display_name": "Display intercoms"
        }
      ]
    },
    {
      "type": null,
      "external_key": null,
      "group": "Layouts",
      "permissions": [
        {
          "id": 11,
          "name": "layouts-cameras-attach",
          "display_name": "Adding a camera to a layout"
        },
        {
          "id": 12,
          "name": "layouts-cameras-detach",
          "display_name": "Removing cameras from layout"
        },
        {
          "id": 9,
          "name": "layouts-destroy",
          "display_name": "Delete Layout"
        },
        {
          "id": 10,
          "name": "layouts-rename",
          "display_name": "Rename Layout"
        },
        {
          "id": 8,
          "name": "layouts-store",
          "display_name": "Creating Layout"
        }
      ]
    },
    {
      "type": null,
      "external_key": null,
      "group": "Maps",
      "permissions": [
        {
          "id": 38,
          "name": "map-destroy",
          "display_name": "Delete card"
        },
        {
          "id": 34,
          "name": "map-index",
          "display_name": "View Maps"
        },
        {
          "id": 36,
          "name": "map-show",
          "display_name": "View Map"
        },
        {
          "id": 35,
          "name": "map-store",
          "display_name": "Map Creation"
        },
        {
          "id": 37,
          "name": "map-update",
          "display_name": "Map Update"
        }
      ]
    },
    {
      "type": null,
      "external_key": null,
      "group": "Tags",
      "permissions": [
        {
          "id": 26,
          "name": "marks-destroy",
          "display_name": "Removing Tags"
        },
        {
          "id": 23,
          "name": "marks-index",
          "display_name": "View Labels"
        },
        {
          "id": 24,
          "name": "marks-store",
          "display_name": "Creating Labels"
        },
        {
          "id": 25,
          "name": "marks-update",
          "display_name": "Label Update"
        }
      ]
    },
    {
      "type": null,
      "external_key": null,
      "group": "PTZ",
      "permissions": [
        {
          "id": 21,
          "name": "ptz",
          "display_name": "PTZ Control"
        }
      ]
    },
    {
      "type": null,
      "external_key": null,
      "group": "Scripts",
      "permissions": [
        {
          "id": 33,
          "name": "scripts-destroy",
          "display_name": "Deleting script"
        },
        {
          "id": 29,
          "name": "scripts-index",
          "display_name": "View script list"
        },
        {
          "id": 31,
          "name": "scripts-show",
          "display_name": "View script"
        },
        {
          "id": 30,
          "name": "scripts-store",
          "display_name": "Saving script"
        },
        {
          "id": 32,
          "name": "scripts-update",
          "display_name": "Script Update"
        }
      ]
    }
  ],
  "external_events": [
    {
      "id": 18,
      "name": "face-recognized",
      "description": "Person identified",
      "color": "#07D4F0",
      "analytic_type": "face"
    },
    {
      "id": 19,
      "name": "face-unrecognized",
      "description": "Person not identified",
      "color": "#91D4E2",
      "analytic_type": "face"
    },
    {
      "id": 41,
      "name": "person-counting",
      "description": "Count objects in an area",
      "color": "#FF7CF2",
      "analytic_type": "person-counting"
    },
    {
      "id": 28,
      "name": "motion_detect",
      "description": "Zone intrusion detection",
      "color": "#5AD057",
      "analytic_type": "motion_detect"
    },
    {
      "id": 20,
      "name": "licplate-recognized",
      "description": "Number identified",
      "color": "#3EDE9B",
      "analytic_type": "licplate-recognition"
    },
    {
      "id": 21,
      "name": "licplate-unrecognized",
      "description": "Number not identified",
      "color": "#628BFF",
      "analytic_type": "licplate-recognition"
    },
    {
      "id": 27,
      "name": "visitors-counting",
      "description": "Visitor detection",
      "color": "#8B3EBA",
      "analytic_type": "visitors-counting"
    },
    {
      "id": 33,
      "name": "camera-obstacle",
      "description": "Camera damage/overlap/vandalism detection",
      "color": "#2542DF",
      "analytic_type": "camera-obstacle"
    }
  ],
  "system_events": [
    {
      "name": "stream_high_active",
      "title": "High quality stream active"
    },
    {
      "name": "stream_high_inactive",
      "title": "High quality stream is inactive"
    },
    {
      "name": "stream_low_active",
      "title": "Low quality stream active"
    },
    {
      "name": "stream_low_inactive",
      "title": "Low quality stream is inactive"
    }
  ],
  "camera_events": [
    {
      "name": "motion_detect_smtp",
      "description": "Detection of SMTP traffic"
    }
  ],
  "video_rates": [
    1,
    5,
    10
  ],
  "event_reactions": [
    {
      "id": 2,
      "name": "set-mark",
      "description": "Set label",
      "is_default": false
    },
    {
      "id": 4,
      "name": "show-camera",
      "description": "Open camera",
      "is_default": false
    },
    {
      "id": 7,
      "name": "telegram-message",
      "description": "Send a message to telegram",
      "is_default": false
    },
    {
      "id": 8,
      "name": "show-camera-sidebar",
      "description": "Display event in Sidebar",
      "is_default": false
    },
    {
      "id": 9,
      "name": "sound",
      "description": "Sound notification",
      "is_default": false
    },
    {
      "id": 10,
      "name": "without-reaction",
      "description": "No reaction",
      "is_default": true
    }
  ],
  "analytic_files_types": [
    {
      "name": "face_resource",
      "description": "Faces"
    },
    {
      "name": "plate_resource",
      "description": "Vehicle license plates"
    }
  ],
  "analytic_case_camera_status": [
    {
      "name": "processed",
      "description": "Active"
    },
    {
      "name": "unprocessed",
      "description": "Inactive"
    }
  ],
  "analytic_case_status": [
    {
      "name": "active",
      "description": "Active"
    },
    {
      "name": "inactive",
      "description": "Inactive"
    }
  ],
  "intercom_end_call": "60",
  "analytic_license": [
    {
      "type": "analytic_l1",
      "data": [
        {
          "type": "loud-sound-detection",
          "permission": "analytic-cases-loud-sounds"
        },
        {
          "type": "smoke-fire",
          "permission": "analytic-cases-smoke-fire"
        },
        {
          "type": "line-intersection",
          "permission": "analytic-cases-line-intersection"
        },
        {
          "type": "camera-obstacle",
          "permission": "analytic-cases-camera-obstacle"
        },
        {
          "type": "motion_detect",
          "permission": "analytic-cases-motion-detect"
        }
      ]
    },
    {
      "type": "analytic_l2",
      "data": [
        {
          "type": "person-counting",
          "permission": "analytic-cases-person-counting"
        },
        {
          "type": "visitors-counting",
          "permission": "analytic-cases-visitor-counting"
        }
      ]
    },
    {
      "type": "analytic_l3",
      "data": [
        {
          "type": "face",
          "permission": "analytic-cases-face"
        },
        {
          "type": "licplate-recognition",
          "permission": "analytic-cases-license-plate"
        }
      ]
    }
  ],
  "visitor_counter_filters": {
    "steps": [
      {
        "name": "minute",
        "description": "Minute"
      },
      {
        "name": "hour",
        "description": "Hour"
      },
      {
        "name": "day",
        "description": "Day"
      }
    ],
    "sexes": [
      {
        "name": "male",
        "description": "Male"
      },
      {
        "name": "female",
        "description": "Female"
      }
    ],
    "ages": [
      {
        "name": "under_18_years",
        "description": "Under 18 years old"
      },
      {
        "name": "18_30_years",
        "description": "18-30 years old"
      },
      {
        "name": "30_45_years",
        "description": "30-45 years"
      },
      {
        "name": "45_60_years",
        "description": "45-60 years old"
      },
      {
        "name": "over_60_years",
        "description": "60 years"
      }
    ]
  },
  "analytic_events": [
    {
      "id": 18,
      "name": "face-recognized",
      "title": "Person Identified",
      "color": "#07D4F0",
      "analytic_type": "face"
    },
    {
      "id": 19,
      "name": "face-unrecognized",
      "title": "Person not identified",
      "color": "#91D4E2",
      "analytic_type": "face"
    },
    {
      "id": 41,
      "name": "person-counting",
      "title": "Counting objects in an area",
      "color": "#FF7CF2",
      "analytic_type": "person-counting"
    },
    {
      "id": 28,
      "name": "motion_detect",
      "title": "Zone Intrusion Detection",
      "color": "#5AD057",
      "analytic_type": "motion_detect"
    },
    {
      "id": 20,
      "name": "licplate-recognized",
      "title": "Number Identified",
      "color": "#3EDE9B",
      "analytic_type": "licplate-recognition"
    },
    {
      "id": 21,
      "name": "licplate-unrecognized",
      "title": "Identified Number",
      "color": "#628BFF",
      "analytic_type": "licplate-recognition"
    },
    {
      "id": 27,
      "name": "visitors-counting",
      "title": "Visitor detection",
      "color": "#8B3EBA",
      "analytic_type": "visitors-counting"
    },
    {
      "id": 33,
      "name": "camera-obstacle",
      "title": "Camera damage/overlap/vandalism detection",
      "color": "#2542DF",
      "analytic_type": "camera-obstacle"
    }
  ],
  "analytic_cases": [
    {
      "name": "face",
      "description": "Face recognition",
      "fields": {
        "threshold": 50
      }
    },
    {
      "name": "person-counting",
      "description": "Count objects in an area",
      "fields": {
        "reaction_after_value": 10
      }
    },
    {
      "name": "motion_detect",
      "description": "Zone Intrusion Detection"
    },
    {
      "name": "licplate-recognition",
      "description": "License plate recognition"
    },
    {
      "name": "visitors-counting",
      "description": "People Counting"
    },
    {
      "name": "camera-obstacle",
      "description": "Camera damage/overlap/vandalism detection"
    }
  ],
  "bridge_events": [
    {
      "name": "user.bridge.activated",
      "description": "Bridge activated."
    },
    {
      "name": "user.bridge.deactivated",
      "description": "Bridge disabled"
    }
  ],
  "logos": {
    "dark": [
      {
        "id": 243,
        "type": "smart_banner_client",
        "title": "Smart banner client",
        "description": "Smart banner icon for mobile applications in mobile browser versions for iOS and Android OS",
        "url": "http://127.0.0.1:8000/storage/favicons/client/smart-banner.png",
        "version": 1
      },
      {
        "id": 257,
        "type": "login",
        "title": "Authorization page",
        "description": "Product logo on web client and admin login page",
        "url": "http://127.0.0.1:8000/storage/logos/dark/en/login.svg",
        "version": 1
      },
      {
        "id": 261,
        "type": "client_header",
        "title": "Web client",
        "description": "The logo is located in the web client on the top panel of the interface",
        "url": "http://127.0.0.1:8000/storage/logos/dark/en/client_header.svg",
        "version": 1
      }
    ],
    "light": [
      {
        "id": 243,
        "type": "smart_banner_client",
        "title": "Smart banner client",
        "description": "Smart banner icon for mobile applications in mobile browser versions for iOS and Android OS",
        "url": "http://127.0.0.1:8000/storage/favicons/client/smart-banner.png",
        "version": 1
      },
      {
        "id": 263,
        "type": "login",
        "title": "Authorization page",
        "description": "Product logo on web client and admin login page",
        "url": "http://127.0.0.1:8000/storage/logos/light/en/login.svg",
        "version": 1
      },
      {
        "id": 267,
        "type": "client_header",
        "title": "Web client",
        "description": "The logo is located in the web client on the top panel of the interface",
        "url": "http://127.0.0.1:8000/storage/logos/light/en/client_header.svg",
        "version": 1
      }
    ]
  },
  "qr": "schema://connection/somedata",
  "is_need_to_show_subuser_popup": true,
  "analytic_case_camera_user_status": [
    {
      "name": "failed_to_create",
      "description": "Creation error",
      "text": "Camera creation failed. Please try again later"
    },
    {
      "name": "failed_to_update",
      "description": "Update failed",
      "text": "Camera update failed. Please try again later"
    },
    {
      "name": "failed_to_delete",
      "description": "Uninstall error",
      "text": "Could not delete the camera. Please try again later."
    }
  ],
  "camera_status": [
    {
      "name": "active",
      "description": "Active"
    },
    {
      "name": "inactive",
      "description": "Inactive"
    },
    {
      "name": "partial",
      "description": "Partially active"
    },
    {
      "name": "blocked",
      "description": "Blocked"
    }
  ],
  "map_cameras_limit": 16,
  "maps_tree_max_depth": "5",
  "intercom_call_events": [
    {
      "name": "missed_intercom_call",
      "title": "Missed call"
    },
    {
      "name": "answered_intercom_call",
      "title": "Answered call
    }
  ]
}

401 Unauthorized

Authorization token not sent or not valid

cURL
BASH
curl -k --request POST \
	--url 'https://your-domain/api/v1/static' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '[]'
PHP
PHP
$data = array (
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'GET',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/v1/static', false, $context);
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.