M2A Multiviewer API (v1)

Download OpenAPI specification:

Product Team: team@m2amedia.tv URL: m2amedia.tv/apis/support License: MIT

This is the API specification of the M2A Multiviewer API

events

Event endpoints of the Multiviewer API

List all events

Authorizations:

http_security_schema

query Parameters

target-account-id required	string (Resource identifier) Example: target-account-id=a79e10d1-bbcb-4297-a246-c3223137bbd0 The id of the owning target account
limit	integer Specifies the maximum number of results to return in the response.
offset	string The last evaluated page key
sortby	string Describes how to sort the items

Responses

Response samples

Content type

application/vnd.api+json

{"links": {"next": "/api/multiviewer/v1/events/?offset=eyJwayI6IHsiUyI6ICIwOThjNzM0NC05NjQ5LTQyYWUtYTA5Ny0xMzJjN2ZiYWZjNTMjZTk0MDc3MzMtODY3YS00ZmFkLThkN2EtOTNiMWIyNmM4YjAxIn0sICJzayI6IHsiUyI6ICJvd25lciMwOThjNzM0NC05NjQ5LTQyYWUtYTA5Ny0xMzJjN2ZiYWZjNTMifSwgImVuZF90aW1lIjogeyJTIjogIjIwMjItMDktMTNUMTg6MTU6MjMuNzQ5MDQ2KzAwMDAifX0%3D&target-account-id=098c7344-9649-42ae-a097-132c7fbafc53"
},
"data": [{"id": "a79e10d1-bbcb-4297-a246-c3223137bbd0",
"type": "events",
"attributes": {"end-time": "2024-04-12T11:04:00+00:00",
"event-description": "My awsome event",
"event-name": "Multiviewer Testing",
"on-air-end-time": "2024-04-12T10:49:00+00:00",
"on-air-start-time": "2024-04-12T09:49:00+00:00",
"start-time": "2024-04-12T08:49:00+00:00",
"tile": {"type": "encoder",
"format": "img/jpeg",
"url": "https://example.com/1.jpg?Expires=1704115800&Signature=ABC&Key-Pair-Id=456",
"resources": ["mrn:prod:encoders:098c7344-9649-42ae-a097-132c7fbafc53:encoder/8c4c1d2e-a3b4-4c5d-9e6f-1a2b3c4d5e6f",
"mrn:prod:workflows:098c7344-9649-42ae-a097-132c7fbafc53:workflow-instance/2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
"mrn:prod:stream-endpoint-discovery:098c7344-9649-42ae-a097-132c7fbafc53:endpoint/3c4d5e6f-7a8b-4c9d-0e1f-2a3b4c5d6e7f"
],
"settings": {"expires": "2024-01-01T13:30:00+00:00",
"refresh-interval": 2
}
}
},
"relationships": {"owner": {"data": {"id": "098c7344-9649-42ae-a097-132c7fbafc53",
"type": "target-accounts"
}
}
}
},
{"id": "a79e10d1-bbcb-4297-a246-c3223137bbd0",
"type": "events",
"attributes": {"end-time": "2024-04-12T11:04:00+00:00",
"event-description": "My awsome event",
"event-name": "Multiviewer Testing",
"on-air-end-time": "2024-04-12T10:49:00+00:00",
"on-air-start-time": "2024-04-12T09:49:00+00:00",
"start-time": "2024-04-12T08:49:00+00:00",
"tile": {"format": "video/mp4",
"type": "placeholder",
"url": "https://d1yrd72unc6fa0.cloudfront.net/mcm_in_progress_slate.m4v",
"resources": [ ]
}
},
"relationships": {"owner": {"data": {"id": "098c7344-9649-42ae-a097-132c7fbafc53",
"type": "target-accounts"
}
}
}
}
]
}

List all events with components

Authorizations:

http_security_schema

query Parameters

target-account-id required	string (Resource identifier) Example: target-account-id=a79e10d1-bbcb-4297-a246-c3223137bbd0 The id of the owning target account
limit	integer Specifies the maximum number of results to return in the response.
offset	string The last evaluated page key
sortby	string Describes how to sort the items

Responses

Response samples

Content type

application/vnd.api+json

{"links": {"next": "/api/multiviewer/v1/events/complete/?offset=eyJwayI6IHsiUyI6ICIwOThjNzM0NC05NjQ5LTQyYWUtYTA5Ny0xMzJjN2ZiYWZjNTMjZTk0MDc3MzMtODY3YS00ZmFkLThkN2EtOTNiMWIyNmM4YjAxIn0sICJzayI6IHsiUyI6ICJvd25lciMwOThjNzM0NC05NjQ5LTQyYWUtYTA5Ny0xMzJjN2ZiYWZjNTMifSwgImVuZF90aW1lIjogeyJTIjogIjIwMjItMDktMTNUMTg6MTU6MjMuNzQ5MDQ2KzAwMDAifX0%3D&target-account-id=098c7344-9649-42ae-a097-132c7fbafc53"
},
"data": [{"id": "a79e10d1-bbcb-4297-a246-c3223137bbd0",
"type": "events",
"attributes": {"end-time": "2024-04-12T11:04:00+00:00",
"event-description": "My awsome event",
"event-name": "Multiviewer Testing",
"on-air-end-time": "2024-04-12T10:49:00+00:00",
"on-air-start-time": "2024-04-12T09:49:00+00:00",
"start-time": "2024-04-12T08:49:00+00:00",
"tile": {"type": "encoder",
"format": "img/jpeg",
"url": "https://example.com/1.jpg?Expires=1704115800&Signature=ABC&Key-Pair-Id=456",
"resources": ["mrn:prod:encoders:098c7344-9649-42ae-a097-132c7fbafc53:encoder/8c4c1d2e-a3b4-4c5d-9e6f-1a2b3c4d5e6f",
"mrn:prod:workflows:098c7344-9649-42ae-a097-132c7fbafc53:workflow-instance/2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
"mrn:prod:stream-endpoint-discovery:098c7344-9649-42ae-a097-132c7fbafc53:endpoint/3c4d5e6f-7a8b-4c9d-0e1f-2a3b4c5d6e7f"
],
"settings": {"expires": "2024-01-01T13:30:00+00:00",
"refresh-interval": 2
}
},
"sources": [{"auth": {"type": "token",
"location": "location",
"key": "auth_key",
"value": "value_key"
},
"id": "503bd07e-d6da-464f-a9ea-ea4e87be100f",
"name": "source_name",
"status": "active",
"updated": "2024-04-12T09:46:05",
"format": "application/dash+xml",
"url": "https://d1r4drag4iybc5.cloudfront.net/proxy/004a3ccf-2f4d-4a45-8e0a-f44f60f386a7/index.mpd",
"resources": ["mrn:prod:connect:098c7344-9649-42ae-a097-132c7fbafc53:source/5e6f7a8b-9c0d-4e1f-2a3b-4c5d6e7f8a9b"
]
}
],
"endpoints": [{"auth": {"type": "token",
"location": "location",
"key": "auth_key",
"value": "value_key"
},
"id": "503bd07e-d6da-464f-a9ea-ea4e87be100f",
"name": "endpoint_name",
"status": "active",
"updated": "2024-04-12T09:46:05",
"format": "application/dash+xml",
"url": "https://d1r4drag4iybc5.cloudfront.net/proxy/004a3ccf-2f4d-4a45-8e0a-f44f60f386a7/index.mpd",
"resources": ["mrn:prod:workflows:098c7344-9649-42ae-a097-132c7fbafc53:workflow-instance/2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
"mrn:prod:packagers:098c7344-9649-42ae-a097-132c7fbafc53:packager/4d5e6f7a-8b9c-4d0e-1f2a-3b4c5d6e7f8a",
"mrn:prod:stream-endpoint-discovery:098c7344-9649-42ae-a097-132c7fbafc53:endpoint/3c4d5e6f-7a8b-4c9d-0e1f-2a3b4c5d6e7f"
]
}
],
"encoders": [{"auth": {"type": "token",
"location": "location",
"key": "auth_key",
"value": "value_key"
},
"id": "503bd07e-d6da-464f-a9ea-ea4e87be100f",
"name": "encoder_name",
"status": "active",
"updated": "2024-04-12T09:46:05",
"format": "img/jpeg",
"url": "https://example.com/1.jpg?Expires=1704115800&Signature=ABC&Key-Pair-Id=456",
"resources": ["mrn:prod:encoders:098c7344-9649-42ae-a097-132c7fbafc53:encoder/8c4c1d2e-a3b4-4c5d-9e6f-1a2b3c4d5e6f",
"mrn:prod:workflows:098c7344-9649-42ae-a097-132c7fbafc53:workflow-instance/2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
"mrn:prod:stream-endpoint-discovery:098c7344-9649-42ae-a097-132c7fbafc53:endpoint/3c4d5e6f-7a8b-4c9d-0e1f-2a3b4c5d6e7f"
],
"settings": {"expires": "2024-01-01T13:30:00+00:00",
"refresh-interval": 2
}
}
]
},
"relationships": {"owner": {"data": {"id": "098c7344-9649-42ae-a097-132c7fbafc53",
"type": "target-accounts"
}
}
}
},
{"id": "9893b65e-80a9-41ce-8c98-2be6d78053b0",
"type": "events",
"attributes": {"end-time": "2024-04-12T11:04:00+00:00",
"event-description": "My awsome event",
"event-name": "Multiviewer Testing",
"on-air-end-time": "2024-04-12T10:49:00+00:00",
"on-air-start-time": "2024-04-12T09:49:00+00:00",
"start-time": "2024-04-12T08:49:00+00:00",
"tile": {"format": "video/mp4",
"type": "placeholder",
"url": "https://d1yrd72unc6fa0.cloudfront.net/mcm_in_progress_slate.m4v",
"resources": [ ]
},
"sources": [{"auth": {"type": "token",
"location": "location",
"key": "auth_key",
"value": "value_key"
},
"id": "503bd07e-d6da-464f-a9ea-ea4e87be100f",
"name": "source_name",
"status": "pending",
"updated": "2024-04-12T09:46:05",
"format": "video/mp4",
"url": "https://d1yrd72unc6fa0.cloudfront.net/mcm_proxy_disabled_slate.m4v",
"resources": ["mrn:prod:connect:098c7344-9649-42ae-a097-132c7fbafc53:source/6f7a8b9c-0d1e-4f2a-3b4c-5d6e7f8a9b0c"
]
}
]
},
"relationships": {"owner": {"data": {"id": "098c7344-9649-42ae-a097-132c7fbafc53",
"type": "target-accounts"
}
}
}
}
]
}

Info for a specific event

Retrieves information about a specific event

Authorizations:

http_security_schema

path Parameters

event-id

required

string (Resource identifier)

Example: a79e10d1-bbcb-4297-a246-c3223137bbd0

The id of the event to retrieve or delete

query Parameters

target-account-id

required

string (Resource identifier)

Example: target-account-id=a79e10d1-bbcb-4297-a246-c3223137bbd0

The id of the owning target account

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"id": "a79e10d1-bbcb-4297-a246-c3223137bbd0",
"type": "string",
"attributes": {"end-time": "2021-01-30T08:00:00Z",
"event-description": "string",
"event-name": "string",
"on-air-end-time": "2021-01-30T08:00:00Z",
"on-air-start-time": "2021-01-30T08:00:00Z",
"start-time": "2021-01-30T08:00:00Z",
"tile": {"format": "string",
"url": "string",
"resources": ["string"
],
"type": "placeholder"
},
"sources": [{"name": "string",
"status": "active",
"auth": {"type": "session",
"location": "string",
"key": "string",
"value": "string"
},
"format": "string",
"url": "string",
"updated": "2021-01-30T08:00:00Z",
"resources": ["string"
],
"type": "source"
}
],
"endpoints": [{"type": "endpoint",
"name": "Endpoint component",
"status": "active",
"format": "application/dash+xml",
"url": "https://example.com/index.mpd",
"updated": "2024-01-01T00:00:00+00:00",
"auth": {"type": "token",
"location": "location",
"key": "auth_key",
"value": "value_key"
},
"resources": ["mrn:prod:workflows:7e2f2cf8-5ca3-4b66-b4e6-89633ef85fac:workflow-instance/2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
"mrn:prod:packagers:7e2f2cf8-5ca3-4b66-b4e6-89633ef85fac:packager/4d5e6f7a-8b9c-4d0e-1f2a-3b4c5d6e7f8a",
"mrn:prod:stream-endpoint-discovery:7e2f2cf8-5ca3-4b66-b4e6-89633ef85fac:endpoint/3c4d5e6f-7a8b-4c9d-0e1f-2a3b4c5d6e7f"
]
}
],
"encoders": [{"type": "encoder",
"name": "Encoder component",
"status": "active",
"format": "img/jpeg",
"url": "https://example.com/1.jpg?Expires=1704115800&Signature=ABC&Key-Pair-Id=456",
"updated": "2024-01-01T00:00:00+00:00",
"auth": {"type": "token",
"location": "location",
"key": "auth_key",
"value": "value_key"
},
"settings": {"expires": "2024-01-01T13:30:00+00:00",
"refresh-interval": 2
},
"resources": ["mrn:prod:encoders:7e2f2cf8-5ca3-4b66-b4e6-89633ef85fac:encoder/8c4c1d2e-a3b4-4c5d-9e6f-1a2b3c4d5e6f",
"mrn:prod:workflows:7e2f2cf8-5ca3-4b66-b4e6-89633ef85fac:workflow-instance/2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
"mrn:prod:stream-endpoint-discovery:7e2f2cf8-5ca3-4b66-b4e6-89633ef85fac:endpoint/3c4d5e6f-7a8b-4c9d-0e1f-2a3b4c5d6e7f"
]
}
]
},
"relationships": {"owner": {"data": {"id": "098c7344-9649-42ae-a097-132c7fbafc53",
"type": "target-accounts"
}
}
}
}
}

Delete a specific event

Deletes a specific event

Authorizations:

http_security_schema

path Parameters

event-id

required

string (Resource identifier)

Example: a79e10d1-bbcb-4297-a246-c3223137bbd0

The id of the event to retrieve or delete

query Parameters

target-account-id

required

string (Resource identifier)

Example: target-account-id=a79e10d1-bbcb-4297-a246-c3223137bbd0

The id of the owning target account

Responses

Response samples

Content type

application/vnd.api+json

{"errors": [{"status": "400",
"title": "Missing Query String Parameter",
"detail": "Missing parameter required: target-account-id"
}
]
}

Components

Component endpoints for the Multiviewer API

Get a list of components

Get a paged list of components either:

for a specific target account and a specific event (with an option to filter components by type using query parameter type) Example URL for getting all type components: https://cloud.m2amedia.tv/api/multiviewer/v1/components?target-account-id=a79e10d1-bbcb-4297-a246-c3223137bbd0&event-id=6bf270e5-bac4-4193-baea-3af5663e3fa5.
or for a specific target account and a set of events using the comma-separated event-ids query parameter (with an option to filter components by type using query parameter type). Example URL: https://cloud.m2amedia.tv/api/multiviewer/v1/components?target-account-id=a79e10d1-bbcb-4297-a246-c3223137bbd0&event-ids=6bf270e5-bac4-4193-baea-3af5663e3fa5,6bf270e5-bac4-4193-baea-3af5663e3fa6. This is a bulk fetch and follows the partial success pattern. Up to 100 event ids may be supplied; a request exceeding this limit returns 400 Bad Request. Duplicate event ids are de-duplicated on input. The request always returns 200 OK regardless of how many ids resolve: components for resolved events appear in the top-level data array, and any event id that could not be resolved (it does not exist or has been soft-deleted) is reported as an entry in meta.errors carrying the requested id and a 404 status. Events that exist but have no components contribute no entries to data and are not reported as errors. The event-id and event-ids parameters are mutually exclusive.
or for a specific target account and any event with a specific component type. Example URL for getting all source components: https://cloud.m2amedia.tv/api/multiviewer/v1/components?target-account-id=a79e10d1-bbcb-4297-a246-c3223137bbd0&type=source.

Each page has 10 components by default, but page size can be specified using query parameter limit.

In order to get a specific page query parameter offset can be used. Responses for event-ids requests are not paginated, so offset and limit are ignored.

Authorizations:

http_security_schema

query Parameters

target-account-id required	string (Resource identifier) Example: target-account-id=a79e10d1-bbcb-4297-a246-c3223137bbd0 The id of the owning target account
event-id	string <uuid> Example: event-id=6bf270e5-bac4-4193-baea-3af5663e3fa5 Related event id
event-ids	string Example: event-ids=6bf270e5-bac4-4193-baea-3af5663e3fa5,6bf270e5-bac4-4193-baea-3af5663e3fa6 Comma-separated list of related event ids (maximum 100; exceeding this returns `400`). Duplicates are de-duplicated. Mutually exclusive with `event-id`. This is a bulk fetch following the partial success pattern - the response is always `200`, unresolvable ids are reported in `meta.errors`, and results are not paginated.
offset	string The last evaluated page key
limit	integer Specifies the maximum number of results to return in the response.
type	string Enum: "source" "endpoint" "encoder" Component type

header Parameters

Accept

string

Value: "application/vnd.api+json"

Content type (expressed as MIME types) the client is able to understand.

Responses

Response samples

Content type

application/vnd.api+json

Example

Components for a single event (paginated)

{"links": {"next": "/api/multiviewer/v1/components/?offset=eyJwayI6...&target-account-id=098c7344-9649-42ae-a097-132c7fbafc53&type=source"
},
"data": [{"id": "a79e10d1-bbcb-4297-a246-c3223137bbd0",
"type": "components",
"attributes": {"type": "source",
"name": "Source 1",
"event-id": "6bf270e5-bac4-4193-baea-3af5663e3fa5",
"status": "active",
"resources": [ ]
},
"relationships": {"owner": {"data": {"id": "098c7344-9649-42ae-a097-132c7fbafc53",
"type": "target-accounts"
}
}
}
}
]
}

Delete a specific component

Deletes a specific component

Authorizations:

http_security_schema

path Parameters

component-id

required

string (Resource identifier)

Example: a79e10d1-bbcb-4297-a246-c3223137bbd0

The id of the component to retrieve or delete

query Parameters

target-account-id

required

string (Resource identifier)

Example: target-account-id=a79e10d1-bbcb-4297-a246-c3223137bbd0

The id of the owning target account

Responses

Response samples

Content type

application/vnd.api+json

{"errors": [{"status": "400",
"title": "Missing Query String Parameter",
"detail": "Missing parameter required: target-account-id"
}
]
}