DataPulse Connect API Reference

Representative bodies returned by the gateway. Exact data may vary by site.

200 OK

The gateway found configured cameras and returned them in the cameras array.

{
  "cameras": [
    {
      "camera_status": "Disconnected",
      "camera_id": 37,
      "camera_name": "Trade Show Demo",
      "camera_ip_address": "192.168.1.50"
    },
    {
      "camera_status": "Disconnected",
      "camera_id": 38,
      "camera_name": "SecondCamera",
      "camera_ip_address": "192.168.1.39"
    }
  ],
  "rows_selected": 2,
  "edge_device_sn": "MZ00MR0K"
}

200 OK, no cameras

The request succeeded, but this gateway currently has no configured cameras to return.

{
  "cameras": [],
  "rows_selected": 0,
  "edge_device_sn": "MZ00MR0K"
}

Representative bodies returned by the gateway. Exact data may vary by site.

200 OK

The gateway returned its current identity, network, and build metadata.

{
  "edge_device": {
    "serial_number": "MZ00MR0K",
    "device_name": "DataPulse Edge Device",
    "timezone_name": "UTC",
    "adapter_name": "Ethernet 1",
    "mac_address": "74:5D:22:B9:17:BD",
    "ip_address": "10.1.20.51",
    "subnet_mask": "255.255.255.0",
    "network_gateway": "",
    "preferred_dns": "",
    "alternate_dns": "",
    "adapter_name_eth2": "Ethernet 2",
    "mac_address_eth2": "74:5D:22:B9:17:BE",
    "ip_address_eth2": "10.50.0.10",
    "subnet_mask_eth2": "255.255.255.0",
    "network_gateway_eth2": "10.50.0.1",
    "preferred_dns_eth2": "10.50.0.1",
    "alternate_dns_eth2": "",
    "production_area": "",
    "machine_name": "",
    "last_seen_utc": "2026-07-27T00:40:08Z",
    "created_utc": "2026-07-01T14:02:02Z",
    "updated_utc": "2026-07-27T00:40:08Z",
    "system_build": "25.01.12",
    "datapulse_version": "1.19",
    "build_date": "07-09-26"
  }
}

400 Bad Request

The request was rejected because the API token was missing or invalid.

{
  "error": "unauthorized",
  "reason": "invalid_or_missing_token",
  "endpoint": "GetEdgeDeviceInfo",
  "detail": "Authorization failed: invalid or missing X-DP-Token header."
}

Common URL shapes for this endpoint. Values with spaces or slashes should be URL-encoded.

Lookup camera 37

/dw/GetCameraById?CameraId=37

No-match lookup

/dw/GetCameraById?CameraId=999999

Representative bodies returned by the gateway. Exact data may vary by site.

200 OK, match

The requested CameraId matched one configured camera, so the cameras array contains one item.

{
  "cameras": [
    {
      "camera_status": "Disconnected",
      "camera_id": 37,
      "camera_name": "Trade Show Demo",
      "camera_ip_address": "192.168.1.50"
    }
  ],
  "rows_selected": 1,
  "edge_device_sn": "MZ00MR0K"
}

200 OK, no match

The request was valid, but no camera matched the supplied CameraId.

{
  "cameras": [],
  "rows_selected": 0,
  "edge_device_sn": "MZ00MR0K"
}

Common request bodies for filtering inspections. These examples can be sent as the POST JSON body.

Default browse request

An empty request body returns up to 25 of the most recent grouped inspections in browse mode. The default sort is newest first and next_cursor remains null.

{}

Camera + result filter

{
  "camera_id": 37,
  "dp_inspection_result": "Fail",
  "number_of_records": 10
}

Camera + job filter

{
  "camera_id": 37,
  "job_name": "DataPulse Demo",
  "number_of_records": 25
}

Time window

{
  "start_ts_utc": "2026-02-17T18:00:00Z",
  "end_ts_utc": "2026-02-17T19:00:00Z",
  "timestamp_sort_filter": "ASC"
}

Tag value filter

{
  "camera_id": 37,
  "job_name": "DataPulse Demo",
  "tag_value_filter": [
    { "tag": "Port Found", "op": "=", "value": "1" },
    { "tag": "Threshold", "op": ">=", "value": "75" }
  ]
}

Cursor / sync mode

{
  "since_id": 3123,
  "number_of_records": 99,
  "dp_inspection_result": "Fail"
}

Exact file lookup (v1.17+)

Use file_name to fetch one specific inspection. Combine with camera_id and job_name for safety. Returns rows_returned: 1 when found.

{
  "file_name": "Pass/2026/02-17/198_1706390741",
  "camera_id": 37,
  "job_name": "DataPulse Demo"
}

Representative bodies returned by the gateway. Exact data may vary by site.

200 OK, browse mode

Browse mode returns a page of inspections sorted newest-first. Real gateway response (camera 37, DataPulse Demo job). Timestamps use RFC 3339 UTC with milliseconds and trailing Z (v1.17+).

{
  "rows_returned": 1,
  "more_available": true,
  "next_cursor": null,
  "edge_device_sn": "MZ00MR0K",
  "items": [
    {
      "timestamp_utc": "2026-02-17T17:06:38.978Z",
      "camera_id": 37,
      "camera_name": "Trade Show Demo",
      "camera_ip_address": "192.168.1.50",
      "job_name": "DataPulse Demo",
      "file_name": "Pass/2026/02-17/198_1706390741",
      "dp_inspection_result": "Pass",
      "start_id": 424,
      "end_id": 428,
      "tags": {
        "Port Found": "1",
        "Distance": "6.6 mm",
        "Active Bag Size": "500 mL",
        "Threshold": "15",
        "Result": "1"
      }
    }
  ]
}

200 OK, caught-up cursor

Cursor mode is used for sync/polling. This response means the client is caught up and there are no newer matching inspections after the supplied since_id.

{
  "rows_returned": 0,
  "more_available": false,
  "next_cursor": null,
  "edge_device_sn": "MZ00MR0K",
  "items": []
}

Common URL shapes for this endpoint. Values with spaces or slashes should be URL-encoded.

List jobs for camera 37

/dw/ListJobNamesByCamera?CameraId=37

Unknown camera returns empty list

/dw/ListJobNamesByCamera?CameraId=999999

Representative bodies returned by the gateway. Exact data may vary by site.

200 OK, with jobs

The selected camera has inspection data for these job names.

{
  "job_names": [
    "DataPulse Demo",
    "DataPulse Job 2"
  ],
  "camera_id": 37,
  "rows_selected": 2,
  "edge_device_sn": "MZ00MR0K"
}

200 OK, no jobs

The request was valid, but no job names were found for the supplied camera.

{
  "job_names": [],
  "camera_id": 99,
  "rows_selected": 0,
  "edge_device_sn": "MZ00MR0K"
}

Common URL shapes for this endpoint. Values with spaces or slashes should be URL-encoded.

List tags for camera/job

/dw/ListTagsByCameraAndJobName?CameraId=37&JobName=DataPulse%20Demo

Unknown job returns empty tags

/dw/ListTagsByCameraAndJobName?CameraId=37&JobName=ThisJobDoesNotExist

Representative bodies returned by the gateway. Exact data may vary by site.

200 OK, with tags

The selected camera and job pair has these tag names available.

{
  "job_name": "DataPulse Demo",
  "tags": [
    "Active Bag Size",
    "Distance",
    "Port Found",
    "Result",
    "Threshold"
  ],
  "camera_id": 37,
  "rows_selected": 5,
  "edge_device_sn": "MZ00MR0K"
}

200 OK, no tags

The request was valid, but no tags were found for the supplied camera/job pair.

{
  "job_name": "ThisJobDoesNotExist",
  "tags": [],
  "camera_id": 37,
  "rows_selected": 0,
  "edge_device_sn": "MZ00MR0K"
}

Common URL shapes for this endpoint. Values with spaces or slashes should be URL-encoded.

Check image metadata

/dw/GetImageInfo?FileName=Fail%2F2026%2F02-17%2F816_1800353701

Clean miss example

/dw/GetImageInfo?FileName=Fail%2F2099%2F12-31%2F999_9999999999

Representative bodies returned by the gateway. Exact data may vary by site.

200 OK, image metadata

The image exists on disk, and the gateway returned metadata without downloading the image bytes.

{
  "file_name": "Fail/2026/02-17/816_1800353701",
  "image_exists": true,
  "record_exists": true,
  "inspection_timestamp_utc": "2026-02-17T18:00:35.382Z",
  "content_type": "image/bmp",
  "file_size_bytes": 849128,
  "svg_exists": false,
  "edge_device_sn": "MZ00MR0K"
}

404 Not Found

No image file or inspection record exists for the supplied FileName.

{
  "error": "not_found",
  "reason": "image_not_found",
  "endpoint": "GetImageInfo",
  "detail": "No image or inspection record found for FileName 'Fail/2099/12-31/999_9999999999'."
}

Common URL shapes for this endpoint. Values with spaces or slashes should be URL-encoded.

Download image bytes

/dw/DownloadImage?FileName=Fail%2F2026%2F02-17%2F816_1800353701

Clean miss example

/dw/DownloadImage?FileName=Fail%2F2099%2F12-31%2F999_9999999999

Representative bodies returned by the gateway. Exact data may vary by site.

200 OK, image download

The gateway returns image bytes with file-download headers instead of a JSON body.

HTTP/1.1 200 OK
Content-Type: image/bmp
Content-Length: 5014632
Content-Disposition: attachment; filename="819_1800374451.bmp"
X-Edge-Device-SN: MZ00MR0K
Cache-Control: public, max-age=31536000, immutable

[5014632 bytes of raw BMP data]

404 Not Found

No image file or inspection record exists for the supplied FileName.

{
  "error": "not_found",
  "reason": "image_not_found",
  "endpoint": "DownloadImage",
  "detail": "No image or inspection record found for FileName 'Fail/2099/12-31/999_9999999999'."
}

Common URL shapes for this endpoint. Values with spaces or slashes should be URL-encoded.

Download SVG overlay

/dw/DownloadSvg?FileName=Pass%2F2026%2F02-17%2F198_1706390741

Missing SVG example

/dw/DownloadSvg?FileName=Fail%2F2099%2F12-31%2F999_9999999999

Representative bodies returned by the gateway. Exact data may vary by site.

200 OK, SVG download

The gateway returns SVG XML bytes with file-download headers.

HTTP/1.1 200 OK
Content-Type: image/svg+xml
Content-Length: 24816
Content-Disposition: attachment; filename="198_1706390741.svg"
X-Edge-Device-SN: MZ00MR0K
Cache-Control: public, max-age=31536000, immutable

<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 2592 1944">
  <!-- overlay markup -->
</svg>

404 Not Found

No SVG overlay exists for the supplied FileName, or the inspection is no longer available.

{
  "error": "not_found",
  "reason": "svg_not_found",
  "endpoint": "DownloadSvg",
  "detail": "No SVG or inspection record found for FileName 'Fail/2099/12-31/999_9999999999'."
}

Common request bodies for filtering inspections. These examples can be sent as the POST JSON body.

Default audit file list

Returns up to 25 recent audit files across cameras and dates.

{}

Date range + camera

{
  "start_utc": "2025-12-08",
  "end_utc": "2025-12-10",
  "camera_id": 37,
  "limit": 10
}

Representative bodies returned by the gateway. Exact data may vary by site.

200 OK, audit files

The gateway found audit log files matching the requested filters.

{
  "rows_selected": 1,
  "items": [
    {
      "audit_file_name": "2025-12-09/192.168.1.50_2025-12-09.txt",
      "camera_ip_address": "192.168.1.50",
      "camera_id": 37,
      "file_date": "2025-12-09",
      "file_size_bytes": 211204,
      "last_modified_utc": "2025-12-09T23:59:58.842Z"
    }
  ],
  "edge_device_sn": "MZ00MR0K"
}

200 OK, no match

The request was valid, but no audit log files matched the filters.

{
  "rows_selected": 0,
  "items": [],
  "edge_device_sn": "MZ00MR0K"
}

Common URL shapes for this endpoint. Values with spaces or slashes should be URL-encoded.

Download audit file

/dw/DownloadAuditLogFile?AuditFileName=2025-12-09%2F192.168.1.50_2025-12-09.txt

Representative bodies returned by the gateway. Exact data may vary by site.

200 OK, audit log download

The gateway returns raw UTF-8 audit log text with file-download headers.

HTTP/1.1 200 OK
Content-Type: text/plain; charset=utf-8
Content-Length: 211204
Content-Disposition: attachment; filename="192.168.1.50_2025-12-09.txt"
X-Edge-Device-SN: MZ00MR0K
Cache-Control: public, max-age=31536000, immutable

<211204 bytes of UTF-8 RFC5424 syslog records>

404 Not Found

No audit log file exists for the supplied AuditFileName.

{
  "error": "not_found",
  "reason": "audit_file_not_found",
  "endpoint": "DownloadAuditLogFile",
  "detail": "No audit file found at audit_file_name '2099-12-31/192.168.99.99_2099-12-31.txt'."
}

Common request bodies for filtering inspections. These examples can be sent as the POST JSON body.

Default dashboard request

Returns the last 24 hours at hourly grain across all cameras and jobs.

{}

Last 24 hours for one camera/job

{
  "period": "last_24_hours",
  "camera_id": 37,
  "job_name": "DataPulse Demo",
  "aggregation_level": "hour",
  "limit": 24
}

Seven-day pass-rate summary

{
  "period": "last_7_days",
  "camera_id": 37,
  "job_name": "DataPulse Demo",
  "aggregation_level": "all"
}

Custom daily trend

{
  "start_utc": "2026-06-01",
  "end_utc": "2026-06-09",
  "aggregation_level": "day",
  "limit": 99
}

Representative bodies returned by the gateway. Exact data may vary by site.

200 OK, hourly job performance

The gateway returned hourly rollup rows for the requested camera and job.

{
  "rows_selected": 3,
  "items": [
    {
      "camera_id": 37,
      "camera_ip_address": "192.168.1.50",
      "job_name": "datapulse demo",
      "bucket_utc": "2026-06-02T19:00:00Z",
      "aggregation_level": "hour",
      "total_inspections": 412,
      "total_passes": 389,
      "total_fails": 23,
      "pass_rate": 0.9442,
      "first_inspection_utc": "2026-06-02T19:00:08.117Z",
      "last_inspection_utc": "2026-06-02T19:42:51.903Z"
    }
  ],
  "filter": {
    "aggregation_level": "hour",
    "period": "last_24_hours",
    "start_utc": "2026-06-01T20:00:00Z",
    "end_utc": "2026-06-02T20:00:00Z",
    "camera_id": 37,
    "camera_ip_address": "192.168.1.50",
    "job_name": "datapulse demo"
  },
  "edge_device_sn": "MZ00MR0K"
}

200 OK, all-window summary

aggregation_level all collapses the selected time window into one row per camera/job.

{
  "rows_selected": 1,
  "items": [
    {
      "camera_id": 37,
      "camera_ip_address": "192.168.1.50",
      "job_name": "datapulse demo",
      "bucket_utc": null,
      "aggregation_level": "all",
      "total_inspections": 198342,
      "total_passes": 187901,
      "total_fails": 10441,
      "pass_rate": 0.9474,
      "first_inspection_utc": "2026-05-26T20:00:00.412Z",
      "last_inspection_utc": "2026-06-02T19:58:33.119Z"
    }
  ],
  "filter": {
    "aggregation_level": "all",
    "period": "last_7_days",
    "camera_id": 37,
    "camera_ip_address": "192.168.1.50",
    "job_name": "datapulse demo"
  },
  "edge_device_sn": "MZ00MR0K"
}

Representative bodies returned by the gateway. Exact data may vary by site.

200 OK

Real gateway response (gateway MZ00MR0K, 2026-06-23). Disk usage at 19.42 % with 65.58 % headroom before the 85 % deletion threshold.

{
  "edge_device_health": {
    "disk_total_bytes": 253672550400,
    "disk_used_bytes": 49266671616,
    "disk_free_bytes": 204405878784,
    "disk_used_percent": 19.42,
    "deletion_storage_threshold_percent": 85,
    "disk_headroom_percent": 65.58,
    "memory_total_bytes": 8410865664,
    "memory_available_bytes": 5479755776,
    "memory_used_percent": 34.85,
    "collected_utc": "2026-06-23T19:00:20.000Z"
  },
  "edge_device_sn": "MZ00MR0K"
}

400 Bad Request - invalid token

{
  "error": "unauthorized",
  "reason": "invalid_or_missing_token",
  "endpoint": "GetEdgeDeviceHealth",
  "detail": "Authorization failed: invalid or missing X-DP-Token header."
}

500 Internal Server Error

Returned when the gateway cannot collect health metrics. Contact the gateway operator.

{
  "error": "internal_error",
  "reason": "edge_device_health_failed",
  "endpoint": "GetEdgeDeviceHealth",
  "detail": "Internal error while collecting edge device health metrics on the gateway."
}

Common request bodies for filtering inspections. These examples can be sent as the POST JSON body.

Three-hour window - DataPulse Demo

Request that produced the real A1 response above. start/end_utc in RFC 3339 Z format.

{
  "start_utc": "2026-02-17T17:00:00.000Z",
  "end_utc": "2026-02-17T19:59:59.999Z",
  "camera_id": 37,
  "job_name": "DataPulse Demo"
}

With Port Found tag filter

Narrow the aggregate to inspections where Port Found = 1 (pass-only subset). Returns 504 inspections with 98.41 % pass rate.

{
  "start_utc": "2026-02-17T17:00:00.000Z",
  "end_utc": "2026-02-17T19:59:59.999Z",
  "camera_id": 37,
  "job_name": "DataPulse Demo",
  "tag_value_filter": [{"tag": "Port Found", "op": "=", "value": "1"}],
  "dp_inspection_result": "All"
}

Full-day window using bare date

Bare YYYY-MM-DD accepted: start rounds to 00:00:00, end to 23:59:59.999.

{
  "start_utc": "2026-02-17",
  "end_utc": "2026-02-17",
  "camera_id": 37,
  "job_name": "DataPulse Demo"
}

Representative bodies returned by the gateway. Exact data may vary by site.

200 OK - window with data

Real gateway response (gateway MZ00MR0K). 548 inspections for DataPulse Demo camera 37, 2026-02-17. 90.51 % pass rate.

{
  "total_inspections": 548,
  "total_passes": 496,
  "total_fails": 52,
  "total_unknown": 0,
  "pass_rate": 0.9051,
  "first_inspection_utc": "2026-02-17T17:06:38.978Z",
  "last_inspection_utc": "2026-02-17T18:00:35.998Z",
  "filter": {
    "start_utc": "2026-02-17T17:00:00.000Z",
    "end_utc": "2026-02-17T19:59:59.999Z",
    "camera_id": 37,
    "job_name": "DataPulse Demo",
    "tag_value_filter": [],
    "dp_inspection_result": "All"
  },
  "edge_device_sn": "MZ00MR0K"
}

200 OK - empty window (no rows match)

No inspections matched the filters. pass_rate and timestamp fields are null. This is a valid 200, not a 404.

{
  "total_inspections": 0,
  "total_passes": 0,
  "total_fails": 0,
  "total_unknown": 0,
  "pass_rate": null,
  "first_inspection_utc": null,
  "last_inspection_utc": null,
  "filter": {
    "start_utc": "2099-01-01T00:00:00.000Z",
    "end_utc": "2099-01-02T23:59:59.999Z",
    "camera_id": 37,
    "job_name": "DataPulse Demo",
    "tag_value_filter": [],
    "dp_inspection_result": "All"
  },
  "edge_device_sn": "MZ00MR0K"
}

400 - missing time bounds

start_utc (or end_utc) was omitted.

{
  "error": "bad_request",
  "reason": "missing_time_bounds",
  "endpoint": "QueryWindowStats",
  "detail": "start_utc is required."
}

400 - window too large

{
  "error": "bad_request",
  "reason": "window_too_large",
  "endpoint": "QueryWindowStats",
  "detail": "Time window exceeds maximum of 90 days."
}

400 - unknown camera_id

{
  "error": "bad_request",
  "reason": "unknown_camera_id",
  "endpoint": "QueryWindowStats",
  "detail": "camera_id 999 does not match any camera on this gateway."
}