Get video scores result | Coactive AI

curl https://api.coactive.ai/api/v0/video-scores/groups/group_id/tags/tag_id/aggregations/aggregation_id/result \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "meta": {
    "page": {
      "page": 1,
      "per_page": 100
    },
    "has_next_page": true
  },
  "data": [
    {
      "group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "group_name": "Customer Engagement Metrics",
      "tag_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "tag_name": "Positive Sentiment",
      "tag_version_id": "1e4e28a9-8f3b-4d2a-9f3a-2b7f9a1c5d3e",
      "coactive_video_id": "9b2d7f3a-4c1e-4f8a-9d3b-7a2e1f4c5b6d",
      "score": 87.5,
      "criteria_met": true,
      "accepted": true,
      "computed_dt": "2024-01-15T09:30:00Z",
      "video": {
        "id": "9b2d7f3a-4c1e-4f8a-9d3b-7a2e1f4c5b6d",
        "dataset_id": "2a4f6e7b-8c9d-4e1f-9a2b-3c4d5e6f7a8b",
        "created_user_id": "user_12345",
        "updated_user_id": "user_12345",
        "created_dt": "2023-12-01T14:20:00Z",
        "updated_dt": "2024-01-10T11:15:00Z",
        "status": "processed",
        "path": "/videos/2023/12/customer_engagement.mp4",
        "video_key": "videos/2023/12/customer_engagement.mp4",
        "internal_metadata": {
          "resolution": "1920x1080",
          "duration_seconds": 3600
        }
      },
      "video_metadata": {
        "title": "Customer Feedback Session",
        "episode_name": "Q4 Review",
        "video_type": "interview",
        "series_name": "Customer Insights",
        "genre": "Documentary",
        "rating": "PG",
        "content_id": "CF2023Q4"
      },
      "preview_s3_path": "s3://video-previews/customer_engagement/keyframe_001.jpg",
      "preview_asset_start_time_ms": 15000,
      "preview_asset_end_time_ms": 30000
    }
  ],
  "sort": [
    {
      "field": "score",
      "direction": "desc"
    }
  ]
}

Retrieve video scores based on an existing aggregation ID with pagination support.

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.

aggregation_idstringRequiredformat: "uuid"

The ID of the aggregation to retrieve results for.

Query parameters

pageintegerOptional>=1Defaults to 1

Page number (1-indexed).

per_pageintegerOptional1-1000Defaults to 100

Number of items per page.

sort_orderenumOptionalDefaults to desc

Sort order for scores (ascending or descending).

Allowed values:

Response

Successful Response

metaobject

Metadata for pagination.

datalist of objects

The paginated data.

sortlist of objects

Sort details.

Errors

422

Unprocessable Entity Error