The TwentyThree™ API

API Method: /api/analytics/extract/photo-totals

Extract a complete list of aggregated totals from one or more sites updated since a certain point in time.

Parameters

ParameterDescription
site_id A comma-separated list of site_ids to include in the return value.
since A UTC timestamp in the form of "%Y-%m-%d %H:%M:%S" before which totals will be capped. This should be used for continuous updates where the last update was run at "since".

Permission level

The minimum required permission level is:

read

Example XML Response

Analytics extraction endpoints do not support XML output formatting.

Example JSON Response

{
  "status": "ok", 
  "permission_level": "read",
  "cached": "0",
  "analytics": {
    "photos": [
      {
        "photoId": "455471",
        "playthroughAverage": 40.30,
        "plays": 1210.0,
        "finishes": 323.0,
        "downloadedBytes": 121656230731.0,
        "playEngagement": 339332.51,
        "loads": 3398.0,
        "downloads": 3365.0,
        "events": {
          "load": 3.0
        }
      },
      ..
    ]
  },
  "p": 1,
  "size": 256,
  "total_count": 256,
  "site": { ... },
  "endpoint": "/api/analytics/extract/photo-totals"
}