Get video scores result preview | Coactive AI

curl -G https://api.coactive.ai/api/v0/video-scores/groups/group_id/tags/tag_id/aggregations/-/result \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d tag_version_id=tag_version_id \
     -d dataset_id=dataset_id \
     -d strategy=ANY_HIT \
     -d min_conf=0.5

{
  "meta": {
    "page": {
      "page": 1,
      "per_page": 100
    },
    "has_next_page": true
  },
  "data": [
    {
      "group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "group_name": "Sports Highlights",
      "tag_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "tag_name": "Goal Scored",
      "tag_version_id": "1e2d3c4b-5a6f-7e8d-9c0b-1a2b3c4d5e6f",
      "coactive_video_id": "9f8e7d6c-5b4a-3c2d-1e0f-9a8b7c6d5e4f",
      "score": 0.87,
      "criteria_met": true,
      "accepted": true,
      "computed_dt": "2024-01-15T09:30:00Z",
      "video": {
        "id": "9f8e7d6c-5b4a-3c2d-1e0f-9a8b7c6d5e4f",
        "dataset_id": "2a4b6c8d-0e1f-2345-6789-abcdef012345",
        "created_user_id": "user_12345",
        "updated_user_id": "user_12345",
        "created_dt": "2023-12-01T12:00:00Z",
        "updated_dt": "2024-01-10T15:45:00Z",
        "status": "processed",
        "path": "/videos/sports/goal_highlight.mp4",
        "video_key": "sports/goal_highlight_2024.mp4",
        "internal_metadata": {
          "duration_seconds": 180,
          "resolution": "1920x1080"
        }
      },
      "video_metadata": {
        "title": "Championship Final Highlights",
        "episode_name": "Final Match",
        "video_type": "highlight",
        "series_name": "Soccer Season 2024",
        "genre": "Sports",
        "rating": "PG",
        "content_id": "content_987654321"
      },
      "preview_s3_path": "s3://video-previews/sports/goal_highlight_preview.jpg",
      "preview_asset_start_time_ms": 45000,
      "preview_asset_end_time_ms": 60000
    }
  ],
  "sort": [
    {
      "field": "score",
      "direction": "desc"
    }
  ]
}

Retrieve a preview of video scores based on aggregation strategy. Use this endpoint to preview results before creating an aggregation.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

group_idstringRequiredformat: "uuid"

The ID of the Dynamic Tag group.

tag_idstringRequiredformat: "uuid"

The ID of the tag within the group.

Query parameters

tag_version_idstringRequiredformat: "uuid"

The version ID of the tag.

dataset_idstringRequiredformat: "uuid"

The ID of the dataset to query.

strategyenumRequired

The aggregation strategy/methodology to use.

Allowed values:

min_confdoubleRequired<=1

Minimum confidence threshold.

coverage_thresholddoubleOptional<=1

Coverage threshold (required for COVERAGE_THRESHOLD strategy).

engineenumOptionalDefaults to DUCKDB

Backend engine used to query shot scores. DUCKDB (default) supports all strategies; PINOT supports ANY_HIT and COVERAGE_THRESHOLD only.

Allowed values:

max_shot_lengthintegerOptional

Maximum shot length in seconds. Videos with any shot longer than this value are excluded from results. Omit or set to null to disable filtering.

Response

Successful Response

metaobject

Metadata for pagination.

datalist of objects

The paginated data.

sortlist of objects

Sort details.

Errors

400

Bad Request Error

422

Unprocessable Entity Error