Retrieve the list of organizations associated with the access token/owner.
| Argument | Type | Description |
|---|---|---|
ids |
[ID!]
|
IDs of the organizations you want to list. |
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
The default organization associated with this user.
Retrieves a node based on its ID.
The Organization represents the top level object containing objects such as players, campaigns and playlists . Every single object in your system belongs to one, and only one, organization.
Retrieve the list of contents belonging to this organization. Requires a token with content:read permission.
| Argument | Type | Description |
|---|---|---|
kind |
ContentKind
|
Return only contents belonging to this kind. |
name |
String
|
Returns the contents with the given name. |
path |
String
|
If non-null, filter contents whose path, separated by a forward slash (/), start with the given path. The root folder is implicit and should not to be used in the path. |
orderBy |
ContentConnectionOrder
|
Ordering options for the contents returned. If not specified, contents will be ordered by their creation time, from oldest to newest. |
tags |
[String]
|
Filter contents by tags. |
attrs |
[CustomAttribute]
|
Filter contents by custom attributes as an object of |
category |
String
|
Filter contents by category. |
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
Retrieve the Content with the given unique identifier. Requires a token with content:read permission.
| Argument | Type | Description |
|---|---|---|
id |
ID!
|
The content unique identifier. |
Retrieve the list of campaigns belonging to this organization. Requires a token with content:read permission.
| Argument | Type | Description |
|---|---|---|
orderBy |
ConnectionOrder
|
Ordering options for the campaigns returned. If not specified, campaigns will be ordered by their creation time, from oldest to newest. |
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
Retrieve the Campaign with the given unique identifier. Requires a token with content:read permission.
| Argument | Type | Description |
|---|---|---|
id |
ID!
|
The campaign unique identifier. |
Retrieve the list of playlists belonging to this organization. Requires a token with content:read permission.
| Argument | Type | Description |
|---|---|---|
orderBy |
ConnectionOrder
|
Ordering options for the playlists returned. If not specified, playlists will be ordered by their creation time, from oldest to newest. |
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
Retrieve the Playlist with the given unique identifier. Requires a token with content:read permission.
| Argument | Type | Description |
|---|---|---|
id |
ID!
|
The playlist unique identifier. |
A player represents a configured player in your organization. Playable items, such as campaigns or playlists, published to a player can be retrieved through player loops. Each player can belong to many groups, which in turn may also contain published playable items. Requires a token with player:read permission.
| Argument | Type | Description |
|---|---|---|
orderBy |
PlayerConnectionOrder
|
Ordering options for the players returned. If not specified, players will be ordered by their creation time, from oldest to newest. |
first |
Int!
|
Returns the first n elements from the list. |
family |
PlayerFamily
|
Filter players by family. |
appVersion |
String
|
Filter players by app version. For example |
isConnected |
Boolean
|
Filter players by connection status. |
tags |
[String]
|
Filter players by tags. |
attrs |
[CustomAttribute]
|
Filter players by custom attributes as an object of |
after |
String
|
Returns the elements in the list that come after the specified cursor |
Retrieve the Player with the given unique identifier. Requires a token with player:read permission.
| Argument | Type | Description |
|---|---|---|
id |
ID!
|
The player unique identifier. |
Retrieve the list of player groups belonging to this organization. Requires a token with player:read permission.
| Argument | Type | Description |
|---|---|---|
orderBy |
ConnectionOrder
|
Ordering options for the player groups returned. If not specified, player groups will be ordered by their creation time, from oldest to newest. |
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
Retrieve the Player Group with the given unique identifier. Requires a token with player:read permission.
| Argument | Type | Description |
|---|---|---|
id |
ID!
|
The player group unique identifier. |
Retrieve the list of reports belonging to this organization. Requires a token with report:read permission.
| Argument | Type | Description |
|---|---|---|
contentType |
ReportContentType
|
Return reports that match this type of content. |
periodicity |
ReportPeriodicity
|
Return reports that match this periodicity. |
aggregation |
ReportAggregation
|
Return reports that match this aggregation. |
format |
ReportFormat
|
Return reports that match this output format. |
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
Retrieve the Report with the given unique identifier. Requires a token with report:read permission.
| Argument | Type | Description |
|---|---|---|
id |
ID!
|
The report unique identifier. |
The users of the organization. Requires a token with user:read permission.
| Argument | Type | Description |
|---|---|---|
first |
Int!
|
Returns the first n elements from the list. |
orderBy |
UserConnectionOrder
|
Ordering options for the users returned. If not specified, users will be ordered by their creation time, from oldest to newest. |
name |
String
|
The user name. |
email |
String
|
The user email. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
Retrieve the User with the given unique identifier. Requires a token with user:read permission.
| Argument | Type | Description |
|---|---|---|
id |
ID!
|
The user unique identifier. |
A list of user groups in the organization. Requires a token with user:read permission.
| Argument | Type | Description |
|---|---|---|
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
Retrieve the Group with the given unique identifier. Requires a token with user:read permission.
| Argument | Type | Description |
|---|---|---|
id |
ID!
|
The group unique identifier. |
Retrieve the list of Data Feeds belonging to this organization. Requires a token with content:read permission.
| Argument | Type | Description |
|---|---|---|
name |
String
|
Returns the Data Feed with the given name. |
orderBy |
ContentConnectionOrder
|
Ordering options for the contents returned. If not specified, contents will be ordered by their creation time, from oldest to newest. |
tags |
[String]
|
Filter Data Feed by tags. |
attrs |
[CustomAttribute]
|
Filter Data Feed by custom attributes as an object of |
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
Retrieve the Data Feed with the given unique identifier. Requires a token with content:read permission.
| Argument | Type | Description |
|---|---|---|
id |
ID!
|
The Data Feed unique identifier. |
GUID for a resource
The organization user-given name.
Whether the organization is active or not.
Retrieve the root folder for this organization. All content belonging to this organization will be children of the root folder. The name of the root folder is the email of the organization owner. Requires a token with content:read permission.
Requires a token with content:read permission.
| Argument | Type | Description |
|---|---|---|
orderBy |
ContentConnectionOrder
|
Ordering options for the contents returned. |
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
GUID for a resource
Content name. If content is a file, name will include the file extension.
The content tags. Can be empty.
Returns the custom attributes as an object of {'Attribute Name': 'Attribute Value'}. Only attributes with defined values will be returned.
Players will skip content that is paused, but will still download them. Useful for temporarily putting content on hold.
Players will skip content that fail a restriction check. Useful for playing items on a schedule or only inside a specific geographic region.
Content last modification date.
Content size in bytes. Directories have no size.
Content parent folder. The root folder has no parent.
Content ancestor (parent directories) IDs.
Public Download URL for the content. No authentication is required when using the URL. Expires in 6 hours. Folders and apps cannot be downloaded. The download URL is unique for each Content and it is different every time it is requested.
Represents the application running on a device, connected to one or more screens.
Requires a token with content:read permission.
| Argument | Type | Description |
|---|---|---|
name |
PlayerLoopType!
|
A list of groups this player belongs to. Requires a token with player:read permission.
| Argument | Type | Description |
|---|---|---|
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
GUID for a resource
The player name.
The player legacyId, still used in some reports.
The number of errors reported by the player in the last 24 hours.
The number of warnings reported by the player in the last 24 hours.
The last date/time the player contacted our servers. If it is currently connected, the current date/time is used.
How many seconds ago the player was last seen. If the player is currently connected this value is 0.
The last content version that the player has downloaded. Can be null if the player never downloaded anything.
How many seconds ago the player last synced. If the player never synced this value is null.
The last date/time the player updated.
How many seconds ago the player last updated. If the player never updated this value is null.
Whether the player is currently connected to our servers.
The player content synchronization progress, in percentage. Ranges from 0 to 100, from out of sync to in sync.
The player Wi-Fi signal strength, in percentage.
The player current timezone.
The player timezone current UTC offset. Changes when daylight savings is active.
A schedule for when the player can be flagged as working. Players outside their working schedule will not be reported as offline if they are disconnected from the API.
A status indicating if the player is currently in its working schedule.
The currently installed player app version, like 'Android 8.2.1'.
The currently installed player OS version, like 'Android 10'.
Tags associated directly to this player.
Whether the player is locked to update to a new version or not. If true the player will not be able to update, neither manually nor automatically.
Whether the player is in maintenance or not. Players in maintenance do not generate email notifications.
The estimated local time of the player.
A pinned note attached to the player.
Subscription informations about the used license by the player.
Returns the player custom attributes as an object of {'Attribute Name': 'Attribute Value'}. Only attributes with defined values will be returned.
Whether the player has a requested update or not.
The date of that player was associated to the current organization. Can be null.
The player current location. Can be null.
The player battery level, in percentage.
The player model, like 'Samsung Galaxy S8'.
The player webview version.
The player SPM version.
Information about the players network interfaces.
SHA of the applied update.
A campaign is a list of files and apps that must be played on a screen following a specific layout and time.
GUID for a resource
The user-given campaign name.
The content tags. Can be empty.
Returns the custom attributes as an object of {'Attribute Name': 'Attribute Value'}. Only attributes with defined values will be returned.
Whether or not this content should be played. Players will skip contents that are paused, but will still download their content. Useful for temporarily putting content on hold.
Whether or not this content should be played based on local conditions. Players will skip content that fail a restriction check. Useful for playing it on a schedule or only inside a specific geographic region.
A user-given category for this campaign. Can be empty.
Campaign last modification date.
Content ancestor (parent directories) IDs.
The list of campaigns, media or other playlists in this playlist. Requires a token with content:read permission.
| Argument | Type | Description |
|---|---|---|
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
GUID for a resource
The user-given playlist name.
The content tags. Can be empty.
Returns the custom attributes as an object of {'Attribute Name': 'Attribute Value'}. Only attributes with defined values will be returned.
Whether or not this content should be played. Players will skip contents that are paused, but will still download their content. Useful for temporarily putting content on hold.
Whether or not this content should be played based on local conditions. Players will skip content that fail a restriction check. Useful for playing it on a schedule or only inside a specific geographic region.
A user-given category for this playlist. Can be empty.
Playlist last modification date.
Playlist ancestor (parent directories) IDs.
https://facebook.github.io/relay/graphql/connections.htm#sec-Edge-Types
https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo
Flattened list of Campaign type
https://facebook.github.io/relay/graphql/connections.htm#sec-Cursor
https://facebook.github.io/relay/graphql/connections.htm#sec-Node
https://facebook.github.io/relay/graphql/connections.htm#sec-Edge-Types
https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo
Flattened list of Content type
https://facebook.github.io/relay/graphql/connections.htm#sec-Cursor
https://facebook.github.io/relay/graphql/connections.htm#sec-Node
A list of contents this user has access to.
The content the user has access to.
Information to aid in pagination.
An edge in a connection.
The permissions the user has on the content.
The content item itself.
Data Feeds provide a powerful way for you to hold structured data, similar to a spreadsheet. Read our guide on Data Feeds to know more.
Retrieve the list of columns belonging to this data feed.
| Argument | Type | Description |
|---|---|---|
columnKind |
DataFeedColumnKinds
|
Filter the columns by kind. |
required |
Boolean
|
Filter the columns by whether they are required. |
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
Retrieve the list of rows belonging to this Data Feed, ordered by their index.
| Argument | Type | Description |
|---|---|---|
status |
DataFeedRowStatus
|
Filter the rows by status. |
values |
JSON
|
Filter the rows by value. Each key is the column ID. E.g. |
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
GUID for a resource
The name of the data feed.
The data feed tags. Can be empty.
The data feed version. Can be used to identify editing conflicts.
Data feed last modification date.
The data feed parent folder ID.
Data feed ancestor folders IDs.
Data Feed columns are used to define the structure of the data feed.
Unique ID for the column.
The name of the column. Must be unique in this data feed.
The order of the column.
The text note of the column.
Whether the column is optional needs to hold a value.
Whether you can edit the column.
The Data Feed from where this column belongs.
https://facebook.github.io/relay/graphql/connections.htm#sec-Edge-Types
https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo
Flattened list of DataFeedColumn type
https://facebook.github.io/relay/graphql/connections.htm#sec-Cursor
https://facebook.github.io/relay/graphql/connections.htm#sec-Node
https://facebook.github.io/relay/graphql/connections.htm#sec-Edge-Types
https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo
Flattened list of DataFeed type
https://facebook.github.io/relay/graphql/connections.htm#sec-Cursor
https://facebook.github.io/relay/graphql/connections.htm#sec-Node
Data Feed rows are used to store the values of each column. Each row can contain two distinct set of values: one approved and one pending, depending on its status.
Unique ID for Row
The status of the row.
The position of the row in the data feed.
An object containing approved values of the row in this format: '{colId1: "colValue1", colId2: 2}'. Only this value can be used in apps and compositions. Is null when the status == "P_INSERT".
An object containing approved values of the row in this format: '{colId1: "colValue1", colId2: 2}'. This value won't be used anywhere before this row is approved. Is null when the status == "APPROVED" || status == "P_DELETE".
The version of the row. Can be used to identify editing conflicts.
The data feed that contains this row.
https://facebook.github.io/relay/graphql/connections.htm#sec-Edge-Types
https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo
Flattened list of DataFeedRow type
https://facebook.github.io/relay/graphql/connections.htm#sec-Cursor
https://facebook.github.io/relay/graphql/connections.htm#sec-Node
Allows playback to only happen within a specified geographic region.
The geographic region unique id.
A location is a geographical point on the earth. Defines the latitude and longitude that result in a coordinate on the surface of the earth.
The location source.
The latitude of the location.
The longitude of the location.
The network interface information of the player.
Network name.
Network MAC address.
Current status of network interface.
Network LAN IP address, when available.
Network SSID, for Wi-Fi networks, when available.
Network Wi-Fi signal strength, measured in decibel milliwatts (dBm). The measurements are available as negative numbers on a scale from -30 dBm to -90 dBm, or null when unavailable.
https://facebook.github.io/relay/graphql/connections.htm#sec-Edge-Types
https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo
Flattened list of Organization type
https://facebook.github.io/relay/graphql/connections.htm#sec-Cursor
https://facebook.github.io/relay/graphql/connections.htm#sec-Node
PageInfo cursor, as defined in https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo
Used to indicate whether more edges exist following the set defined by the clients arguments.
Used to indicate whether more edges exist prior to the set defined by the clients arguments.
The cursor corresponding to the first nodes in edges. Null if the connection is empty.
The cursor corresponding to the last nodes in edges. Null if the connection is empty.
https://facebook.github.io/relay/graphql/connections.htm#sec-Edge-Types
https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo
Flattened list of Player type
https://facebook.github.io/relay/graphql/connections.htm#sec-Cursor
https://facebook.github.io/relay/graphql/connections.htm#sec-Node
Player groups are used to associate campaigns or playlists to multiple players at once. It can also be used to add tags to multiple players, aiding in tag restriction rules.
Information about a specific loop inside the player group. Requires a token with content:read permission.
| Argument | Type | Description |
|---|---|---|
name |
PlayerLoopType!
|
Returns the specified loop type. |
The list of players belonging to this group. Requires a token with player:read permission.
| Argument | Type | Description |
|---|---|---|
orderBy |
PlayerConnectionOrder
|
Ordering options for the players returned. If not specified, players will be ordered by their creation time, from oldest to newest. |
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
The player group unique identifier.
The player group name.
The player group tags. Every player in this group will also automatically have these tags.
https://facebook.github.io/relay/graphql/connections.htm#sec-Edge-Types
https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo
Flattened list of PlayerGroup type
https://facebook.github.io/relay/graphql/connections.htm#sec-Cursor
https://facebook.github.io/relay/graphql/connections.htm#sec-Node
A list of player groups this user has access to.
The player the user has access to.
Information to aid in pagination.
An edge in a connection.
The permissions the user has on the player group.
The player group item itself.
A player loop can be used to associate content to a player or player group. It behaves like a Playlist, but exclusive to a player or player group.
The loop items. Requires a token with content:read permission.
| Argument | Type | Description |
|---|---|---|
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
The play loop unique identifier. Can be used to publish campaigns or playlists to this loop.
The loop kind.
A player note can be used by the user to attach important messages to a player.
The note text.
The note creation date.
The name of the note author.
A list of players this user has access to.
The player the user has access to.
Information to aid in pagination.
An edge in a connection.
The permissions the user has on the player.
The player item itself.
Subscription informations about the used license by the player.
The plan name of the subscription.
The interval of the subscription in months.
The renewal date of the subscription. If null the subscription will not be renewed, otherwise it will be renewed on this date until reaches the endsOn date.
The expiration date of the subscription. If null the subscription will be renewed on the renewsOn date.
https://facebook.github.io/relay/graphql/connections.htm#sec-Edge-Types
https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo
Flattened list of Playlist type
https://facebook.github.io/relay/graphql/connections.htm#sec-Cursor
https://facebook.github.io/relay/graphql/connections.htm#sec-Node
Gathers information about how a campaign or content is configured inside a Playlist or PlayerLoop.
The id of this item inside the Playlist or PlayerLoop.
The position of this item inside the Playlist or PlayerLoop.
The duration for this item. Only available for static items, such as images and apps.
Players will skip items that are paused, but will still download their content. Useful for temporarily putting an item on hold.
Players will skip this item if it fails a restriction check. Useful for playing items on a schedule or only inside a specific geographic region.
The content item itself.
Information to aid in pagination.
Gathers information about how a campaign or content is configured inside a Playlist or PlayerLoop.
The id of this item inside the Playlist or PlayerLoop.
The position of this item inside the Playlist or PlayerLoop.
The duration for this item. Only available for static items, such as images and apps.
Players will skip items that are paused, but will still download their content. Useful for temporarily putting an item on hold.
Players will skip this item if it fails a restriction check. Useful for playing items on a schedule or only inside a specific geographic region.
The content item itself.
Node count for the executed query.
Maximum node counts per request.
Node depth for the executed query.
Maximum node depth per request.
Cost of the executed query, in points.
Maximum consumable points per rate limit window.
Remaining points in the current rate limit window.
The number of seconds until this request can be retried. -1 if request was allowed.
The time at which the current rate limit window resets, in UTC epoch seconds.
A report that runs periodically and contains multiple results from multiple periods.
It contains data about the content playback.
Generating recurring report is an asynchronous task. A recurring report will be run at most once a day on days defined by the schedule.
Once its run, you can check the savedReport property to get the report content, ordered from most recent to least recent.
The players in the report.
Available only when the report was requested for a specific set of players. Requires a token with player:read permission.
| Argument | Type | Description |
|---|---|---|
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
The saved report contents, ordered from most recent to least recent.
If the report has not yet run, this will be null and you can re-check if after nextRecurrence
to see when the report is done. Requires a token with content:read permission.
| Argument | Type | Description |
|---|---|---|
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
The content in the report.
Available only when the report was requested for a specific set of content. Requires a token with content:read permission.
| Argument | Type | Description |
|---|---|---|
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
Report unique identifier.
The report name, mandatory for recurring reports.
The report content type, either campaign or media.
The report periodicity, either single or recurring.
The report aggregation.
The report file format.
Which emails will are notified when the report is ready.
Limit data from players with these tags.
The recurring report recurrence rules and dates. The report is generated on the days that match the rules and dates specified.
The string follows the iCal RRULE property format, more details can be found at: https://tools.ietf.org/html/rfc2445#section-4.8.5.4
The amount of playback data that will be on the report, up to 60 days (or 2 months).
The recurring report amount multiplier when generating reports.
Amount of days from the end of the period to the recurring date.
For instance, if you want a report every 5th of the month containing data from the previous month
set amount to 1, amountType to "MONTH" and "offsetDays" to 5.
The next recurrence of the recurring report.
If the report has ended its run and will no longer be generated this is set to null.
Only report interactive content touched by an user.
Include content that have not played through their end
Report only the content that contain all these tags
https://facebook.github.io/relay/graphql/connections.htm#sec-Edge-Types
https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo
Flattened list of Report type
https://facebook.github.io/relay/graphql/connections.htm#sec-Cursor
https://facebook.github.io/relay/graphql/connections.htm#sec-Node
A report that ran only once, at the moment it was created, and contains playback data from a single period.
It contains data about content playback.
Generating a single report is an asynchronous task. Once a report is requested its savedReport property
must be checked periodically to see whether the report is ready.
The players in the report.
Available only when the report was requested for a specific set of players. Requires a token with player:read permission.
| Argument | Type | Description |
|---|---|---|
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
The content in the report.
Available only when the report was requested for a specific set of content. Requires a token with content:read permission.
| Argument | Type | Description |
|---|---|---|
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
Report unique identifier.
The report name, mandatory for recurring reports.
The report content type, either campaign or media.
The report periodicity, either single or recurring.
The report aggregation.
The report file format.
Which emails will are notified when the report is ready.
Limit data from players with these tags.
Only report interactive content touched by an user.
Include content that have not played through their end
Report only the content that contain all these tags
The single report start date.
The single report end date.
The generated report content.
If the report is pending, this will be null and you can re-check if a few seconds to see when the report is done.
The resulting Content will be a ZIP file containing a single entry, which is the requested report data.
The name of that entry varies according to the start and end of the report period. Requires a token with content:read permission.
A user is a person who can log in to the system.
A list of players this user has access to. Requires a token with player:read permission.
| Argument | Type | Description |
|---|---|---|
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
A list of player groups this user has access to. Requires a token with player:read permission.
| Argument | Type | Description |
|---|---|---|
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
A list of contents this user has access to. Requires a token with content:read permission.
| Argument | Type | Description |
|---|---|---|
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
A list of groups this user belongs to. Requires a token with user:read permission.
| Argument | Type | Description |
|---|---|---|
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
GUID for a resource
Whether the user is active or not.
The user email.
The user name.
The user role.
The date/time the user account was created.
The last date/time the user connected to our servers. If it is currently connected, the current date/time is used.
The default folder of the user. That is not the Home folder of the user, but the folder the user will see first when accessing the content.
A list of permissions this user has. Admin users have all permissions of restricted users.
https://facebook.github.io/relay/graphql/connections.htm#sec-Edge-Types
https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo
Flattened list of User type
https://facebook.github.io/relay/graphql/connections.htm#sec-Cursor
https://facebook.github.io/relay/graphql/connections.htm#sec-Node
A user group is a collection of users.
A list of contents this group has access to. Requires a token with content:read permission.
| Argument | Type | Description |
|---|---|---|
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
A list of players this group has access to. Requires a token with player:read permission.
| Argument | Type | Description |
|---|---|---|
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
A list of player groups this group has access to. Requires a token with player:read permission.
| Argument | Type | Description |
|---|---|---|
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
A list of users in the user group. Requires a token with user:read permission.
| Argument | Type | Description |
|---|---|---|
first |
Int!
|
Returns the first n elements from the list. |
after |
String
|
Returns the elements in the list that come after the specified cursor |
GUID for a resource
The user group name.
A list of permissions this group has. All users in a group inherit the permissions of the group.
https://facebook.github.io/relay/graphql/connections.htm#sec-Edge-Types
https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo
Flattened list of UserGroup type
https://facebook.github.io/relay/graphql/connections.htm#sec-Cursor
https://facebook.github.io/relay/graphql/connections.htm#sec-Node
Define a schedule during which the player is flagged as working. Players outside their working schedule will not be reported as offline if they are disconnected from the API. It is also possible to automatically stop the player from playing campaigns, or even turn it off, outside their working hours.
Flag the player as working only when weekDays contains the current day of the week. Week days contains numbers from 0 to 6, from Sunday to Saturday respectively.
Flag the player as working only if the current local time is greater than starTime.
Flag the player as working only if the current local time is less than or equal to endTime.
A report that contains data about the content playback.
Only report interactive content touched by an user.
Include content that have not played through their end
Report only the content that contain all these tags
The content in the report.
Available only when the report was requested for a specific set of content. Requires a token with content:read permission.
A report that runs periodically and contains multiple results from multiple periods.
Generating recurring report is an asynchronous task. A recurring report will be run at most once a day on days defined by the schedule.
Once its run, you can check the savedReport property to get the report content, ordered from most recent to least recent.
The recurring report recurrence rules and dates. The report is generated on the days that match the rules and dates specified.
The string follows the iCal RRULE property format, more details can be found at: https://tools.ietf.org/html/rfc2445#section-4.8.5.4
The amount of playback data that will be on the report, up to 60 days (or 2 months).
The recurring report amount multiplier when generating reports.
Amount of days from the end of the period to the recurring date.
For instance, if you want a report every 5th of the month containing data from the previous month
set amount to 1, amountType to "MONTH" and "offsetDays" to 5.
The next recurrence of the recurring report.
If the report has ended its run and will no longer be generated this is set to null.
The saved report contents, ordered from most recent to least recent.
If the report has not yet run, this will be null and you can re-check if after nextRecurrence
to see when the report is done. Requires a token with content:read permission.
A report contains playback data from campaign or media playback.
Report unique identifier.
The report name, mandatory for recurring reports.
The report content type, either campaign or media.
The report periodicity, either single or recurring.
The report aggregation.
The report file format.
Which emails will are notified when the report is ready.
Limit data from players with these tags.
The players in the report.
Available only when the report was requested for a specific set of players. Requires a token with player:read permission.
A report that ran only once, at the moment it was created, and contains playback data from a single period.
Generating a single report is an asynchronous task. Once a report is requested its savedReport property
must be checked periodically to see whether the report is ready.
The single report start date.
The single report end date.
The generated report content.
If the report is pending, this will be null and you can re-check if a few seconds to see when the report is done.
The resulting Content will be a ZIP file containing a single entry, which is the requested report data.
The name of that entry varies according to the start and end of the report period. Requires a token with content:read permission.
Represents an item that can be put inside a playlist. Can be a campaign, playlist or content.
GUID for a resource
The content name.
The content tags. Can be empty.
Returns the custom attributes as an object of {'Attribute Name': 'Attribute Value'}. Only attributes with defined values will be returned.
Whether or not this content should be played. Players will skip contents that are paused, but will still download their content. Useful for temporarily putting content on hold.
Whether or not this content should be played based on local conditions. Players will skip content that fail a restriction check. Useful for playing it on a schedule or only inside a specific geographic region.
Specifies how a connection should order its nodes.
Specifies which field of the node will be used for ordering.
Specifies if the nodes should be returned from least to greatest or the reverse. If direction is not given, it is assumed to be ASC.
Specified how a to order players in a connection.
Specifies which field of the node will be used for ordering.
Specifies if the nodes should be returned from least to greatest or the reverse. If direction is not given, it is assumed to be ASC.
Specifies how a connection should order its contents.
Specifies which field of the content will be used for ordering.
Specifies if ordering should be done from least to greatest or the reverse. If direction is not given, it is assumed to be ASC.
Specifies how a connection should order its users.
Specifies which field of the user will be used for ordering.
Specifies if ordering should be done from least to greatest or the reverse. If direction is not given, it is assumed to be ASC.
Specifies how a connection should order its Data Feed Rows.
Specifies which field of the Data Feed Row will be used for ordering.
Specifies if ordering should be done from least to greatest or the reverse. If direction is not given, it is assumed to be ASC.
Determines if the resulting connection should be returned from least to greatest or the reverse.
Order nodes from least to greatest.
Order nodes from greatest to least.
Determines which field of the node should be used for ordering it in a list. Regardless of which field is used, the result is guaranteed to be stable, so items with the same name or creation time will always be returned in the same arbitrary order.
Order each node by their creation time.
Order each node by their name.
Determines which field of the player should be used for ordering it in a list. Regardless of which field is used, the result is guaranteed to be stable, so players with the same name, creation time, or last seen date will always be returned in the same arbitrary order.
Order players by creation time.
Order players by when they last connected to our servers.
Order players by name.
Determines which field of the node should be used for ordering it in a list. Regardless of which field is used, the result is guaranteed to be stable, so items with the same name or creation time will always be returned in the same arbitrary order.
Order content by creation time.
Order content by when it was last modified.
Order content by name.
Determines which field of the user should be used for ordering it in a list. Regardless of which field is used, the result is guaranteed to be stable, so users with the same name, creation time, or last seen date will always be returned in the same arbitrary order.
Order users by creation time.
Order users by when they last connected to our servers.
Order users by name.
Determines which field of the Data Feed Row should be used for ordering it in a list. Regardless of which field is used, the result is guaranteed to be stable.
Order rows by creation time.
Order rows by order.
Content kind, used to discern between media, composition or apps.
The content is a folder. It can have children.
The content is an audio file.
The content is an app, with configurable behavior, playable on audio tracks
The content is an app, with configurable behavior, playable on automation tracks
The content is an app, with configurable behavior, configured as a plugin
The content is a data feed.
The content is a JavaScript file.
The content is a CSS file.
The content is a ZIP file.
The content is a Font file.
The content is XML Data.
The content is Binary GL Transmission Format.
The content is GL Transmission Format.
The content is Radiance HDR Image.
The content is PDF.
The content is a CSV file.
The content is an Excel Spreadsheet.
The content is a JSON file.
The content is an app, with configurable behavior.
The content is a campaign.
The content is a composition of images and text.
The content is an HTML file.
The content is an image, like JPEG or PNG.
The content is an MHTML file.
The content is a playlist.
The content is a video, like MP4 or AVI.
The content is a SVG file.
The content is a SWF file.
Used to discern between the kind of content played in a player.
The content is an app, with configurable behavior.
The content is a campaign.
The content is a composition of images and text.
The content is an HTML file.
The content is an image, like JPEG or PNG.
The content is an MHTML file.
The content is a playlist.
The content is a video, like MP4 or AVI.
The content is a SVG file.
The content is a SWF file.
Player family where the player is installed.
Android player.
BrightSign player.
Chrome OS player.
Linux player.
macOS player.
Raspberry Pi player.
Samsung SSP player.
Samsung Tizen player.
webOS player.
Windows player.
QT player.
SOC player.
Player working schedule status.
The player is currently in its working schedule.
The player is currently out of its working schedule.
The player does not have working schedule configured.
How the player will play this content.
Content in the primary loop is what the player plays on a schedule.
Fallback loop content is only played when no content from primary can be played.
Played only once immediately after the player application starts.
Content in this loop is played when something is triggered by the player.
Plays this content only on the secondary screen
Content in the audio loop is played only the audio from a Campaign audio timeline
Content in the automation loop is the Campaign automation modules.
The status of a network interface of the player.
This network interface is disabled in this player.
This network interface is enabled in this player.
This network is enabled and is the primary network in this player.
How the player should play an on-demand content.
Show only content that has been played for a specific reason.
Content in the primary loop is what the player plays on a schedule.
Fallback loop content is only played when no content from primary can be played.
The content is played dynamically.
On Demand loop content is only played when the play button is pressed.
The content is played when an interactivity by local API occurs.
The content is played when crossing the geofence defined.
The content is played when due to an attribute change.
The content is played when an interactivity by key occurs.
The content is played at the specified time.
The content is played when an interactivity by click or touch occurs.
The content is played when another content is timeout.
Columns that will be reported in the CSV file.
How each report counts the exhibitions of playback content.
Reports of this kind count the exhibitions of each campaign or media during the entire report period.
Reports of this kind count the daily exhibitions of each campaign campaign or media for each individual day in the report period.
Reports of this kind count the exhibitions of each campaign or media for each individual player during the report period.
Reports of this kind count the daily exhibitions of each campaign or media for each individual player and for each individual day during the report period.
Reports of this kind show the date and time of individual exhibitions of each campaign or media. It can result in a very large amount of data.
What kind of content is being reported.
Reports with this type of content will count campaign exhibitions.
Reports with this type of content will count individual media exhibitions, regardless of the campaign it was in.
Content reports can count exhibitions of any kind of content playable on a player.
The report file format.
All reports are exported inside a ZIP file with a single entry. That entry will be in one of the formats below.
Report is in HTML. For displaying in a web browser.
Report is in CSV. Easily parseable by a script.
Report is in PDF. Might generate a very large file.
Not available for INDIVIDUAL reports.
Report is in XLSX. Easy to manipulate using Excel or compatible apps.
Not available for INDIVIDUAL reports.
Report is in JSON.
Only available for INDIVIDUAL aggregation of the CONTENT reports.
Recurring report period, used to determine how many days, weeks or months are in the report.
The amount is in days.
The amount is in weeks.
The amount is in months.
Report periodicity, used to discern between single and recurring reports.
A single report. Runs at the moment it is created.
A recurring report, that will run multiple times.
The permissions a user has on a content.
Allows users to use campaigns, playlists, apps and files from this folder on their campaigns and playlists.
Allows users to download files, view the contents of campaigns and playlists.
Allows users to create new folders, upload files and duplicate existing content. Users will be able to modify existing campaigns, playlists and apps.
When given to a folder this permission allows users to remove files inside the folder, but they will not be able to remove the folder itself. When given to a campaign or playlist this permission allows the user to remove the campaign or playlist itself.
Allow restricted users to approve content changes.
The permissions a user has on a player.
Allows users to publish and un-publish campaigns to a specific player, provided they also have publish permission on the campaigns themselves.
Allows users to view all information about a specific player, including all content published to it.
Allows users to view all events, change settings, reboot and update the player.
Allows users to remove a specific player.
The permissions a user has on a player group.
Allows users to publish and un-publish campaigns to a specific player group, provided they also have publish permission on the campaigns themselves.
Allows users to view all information about a specific player group, including all content published to it.
Allows users to add and remove players from this player group, as long as the user has publish or change permission on the player itself.
Allows users to remove a specific player group.
Define the permissions a user can have. Multiple permissions can be assigned to a user.
Allow user to add players
Allow user to create player groups
Allow user to view the dashboard
Allow user to upload files
Allow user to create compositions
Allow user to create apps
Allow user to create playlists
Allow user to create audio playlists
Allow user to create campaigns
Allow user to preview campaigns they have edit access
Allow user to create custom layouts
Allow user to create data feeds
Allow user to view health check
Allow user to create geographic regions
Allow user to create reports
Allow user to connect integration accounts (Facebook, Instagram...)
Allow administrator to create and modify restricted users.
Allow administrator to view and change plans and payment.
Allow administrator to view and change API access tokens.
Define the permissions a user group can have. Multiple permissions can be assigned to a user group.
Allow user to add players
Allow user to create player groups
Allow user to view the dashboard
Allow user to upload files
Allow user to create compositions
Allow user to create apps
Allow user to create playlists
Allow user to create audio playlists
Allow user to create campaigns
Allow user to preview campaigns they have edit access
Allow user to create custom layouts
Allow user to create data feeds
Allow user to view health check
Allow user to create geographic regions
Allow user to create reports
Allow user to connect integration accounts (Facebook, Instagram...)
Text column kind. E.g. 'Hello World'.
URL column kind. E.g. 'https://example.com'.
Date and Time column kind. Expected format is 'YYYY-MM-DDTHH:MM:SSZ'. E.g. '2024-04-28T14:30:00Z'.
Date column kind. Expected format is 'YYYY-MM-DD'. E.g. '2024-04-28'.
Time column kind. Expected format is 'HH:MM:SS'. E.g. '12:34:58'.
Boolean column kind. E.g. true or false.
Number column kind. E.g. 23.05.
Integer column kind. E.g. 23.
Image column kind.
Video column kind.
Image or Video column kind.
List of texts column kind. E.g. ['Hello', 'World'].
The status of the row. Only approved values can be used in apps and compositions.
The row's value was approved for usage.
The row has a value pending insertion, with no value approved. Rows in this status won't be displayed in apps or compositions until they are approved. Once approved rows in this status become "APPROVED".
The row has some value pending editing, with a different value approved. Only the approved value will be displayed in apps and compositions until the pending edit is approved. Once approved rows in this status become "APPROVED".
The row is pending to be deleted. The approved value will be displayed in apps and compositions until the deletion is approved. Rows approved in this status are deleted.
A date string, such as 2007-12-03, compliant with the full-date format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
A time string at UTC, such as 10:15:30, compliant with the full-time format outlined in section 5.6 of the RFC 3339profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
A date-time string with an offset from UTC, such as 2007-12-03T10:15:30+01:00 or 2007-12-03T10:15:30Z
The JSON scalar type represents JSON values as specified by ECMA-404.
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.