All mutations in the OnSign GraphQL API follow the Relay framework specifications.
These mutations accept and emit a identifier string, which allows Relay to track mutations and responses.
Relay uses a common pattern for mutations, where there are root fields on the mutation type with a single argument, input, and where the input and output both contain a client mutation identifier used to reconcile requests and responses.
By convention, mutations are named as verbs, their inputs are the name with "Input" appended at the end, and they return an object that is the name with "Payload" appended.
All mutations may include in their input a clientMutationId string, which is then returned as part of the object returned by the mutation field.
More information about how Relay works can be found on the Relay website:
Add a tag to a player. Requires a token with player:write permission.
The player unique identifier.
The tag to be added
The updated Player
Add a player to a group. Requires a token with player:write permission.
The player unique identifier.
The player group unique identifier.
The updated Player
The player group which the player was added to
Adds a user to a user group. Requires a token with user:write permission.
The user group unique identifier.
The user unique identifier.
The user group that was updated.
Append a new row to the Data Feed. Requires a token with content:write permission.
The Data Feed unique identifier.
A list of row values to be created. Each array item is a JSON with this structure. E.g. { columnId: value, columnId1: value1 }.
The row status is set to pending when requested to be created. Default is false.
The updated Data Feed.
Appends an item (campaign, playlist or content) to a playlist or player loop. Requires a token with content:write permission.
A Playlist ID or Player Loop ID where the playable should be added.
The content to append to the playlist
Sets the duration, in seconds, of static items like images and apps. Can be used to overwrite the duration of videos.
The pause state for this Playable in the Playlist.
The content restrictions
The Playlist item appended to the playlist
Accept row changes from the data feed. Requires a token with content:write permission.
The Data Feed unique identifier.
A list of rows to have their status changes approved. Check DataFeedRowStatus for more info.
The updated Data Feed.
Update multiple playlists in a single mutation, update their pause state, restrictions and items inside them. Requires a token with content:write permission.
Array of playlists to be updated. Up to 100 playlists can be updated at once.
Whether the playlists were updated
Creates a single report, generated only a single time, that will count content exhibitions. Requires a token with report:write permission.
The report name
The start date in the report.
The end date in the report.
The report aggregation.
The report output format.
Report only playback data from these players.
Report only playback data from players belonging to these groups.
Report only playback from players that contain these tags.
Whether an individual player needs to have all given tags or just some of them.
Report only the playback of these contents.
Report only the playback of content that have these tags.
Whether an individual content needs to have all given tags or just some of them.
Report only the playback of any of these content kinds. Defaults to all content kinds.
Report only the playback played any one of these reasons. Defaults to all playback reasons.
Only report interactive content touched by an user. Defaults to false.
Include content that failed to play. Defaults to false.
Include content that have not played through their end. Defaults to false.
Include content tags in the report, available for all aggregation types, except for INDIVIDUAL. Defaults to false.
Include content tags in the report, available for all aggregation types, except for INDIVIDUAL. Defaults to false.
Include player custom attributes in the report, available for all aggregation types, except for INDIVIDUAL. Defaults to false.
Include content custom attributes in the report, available for all aggregation types, except for INDIVIDUAL. Defaults to false.
Add only these columns to CSV output.
Only available for CSV reportFormat and INDIVIDUAL aggregation.
An IMAGE Content.ID that can be used as a report logo image.
Only available when reportFormat is HTML or PDF.
The report logo position.
Only available when reportFormat is HTML or PDF.
A description text that will appear in the report header.
Only available when reportFormat is HTML or PDF.
Save report inside a Zip file to reduce storage use. By default compression is only applied to INDIVIDUAL playback reports.
Send a message to these emails containing a link to download the report.
The created report
Creates a periodic report, that will run multiple times and will count content exhibitions for each period. Requires a token with report:write permission.
The periodic report name
The recurring report rules and dates. The report will be 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
Defines how much data will be contained in a RecurringReport.
The amount of data that are present 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 report aggregation.
The report output format.
Report only playback data from these players.
Report only playback data from players belonging to these groups.
Report only playback from players that contain these tags.
Whether an individual player needs to have all given tags or just some of them.
Report only the playback of these contents.
Report only the playback of content that have these tags.
Whether an individual content needs to have all given tags or just some of them.
Report only the playback of any of these content kinds. Defaults to all content kinds.
Report only the playback played any one of these reasons. Defaults to all playback reasons.
Only report interactive content touched by an user. Defaults to false.
Include content tags in the report, available for all aggregation types, except for INDIVIDUAL. Defaults to false.
Include content tags in the report, available for all aggregation types, except for INDIVIDUAL. Defaults to false.
Include player custom attributes in the report, available for all aggregation types, except for INDIVIDUAL. Defaults to false.
Include content custom attributes in the report, available for all aggregation types, except for INDIVIDUAL. Defaults to false.
Include content that failed to play. Defaults to false.
Include content that have not played through their end. Defaults to false.
Add only these columns to CSV output.
Only available for CSV reportFormat and INDIVIDUAL aggregation.
An IMAGE Content.ID that can be used as a report logo image.
Only available when reportFormat is HTML or PDF.
The report logo position.
Only available when reportFormat is HTML or PDF.
A description text that will appear in the report header.
Only available when reportFormat is HTML or PDF.
Save report inside a Zip file to reduce storage use. By default compression is only applied to INDIVIDUAL playback reports.
Send a message to these emails containing a link to download the report.
The created report
Create a new Data Feed. Requires a token with content:write permission.
The name of the Data Feed.
The tags of the Data Feed.
The parent folder ID. Default is the Organization root folder.
The create operations to be performed on the columns.
The insert operations to be performed on the rows.
The created Data Feed.
Creates a new playlist. Requires a token with content:write permission.
The name of the playlist
The ID of the folder where you want to place the created playlist. If not specified, the playlist will be placed on the root folder
The playlist category.
The playlist tags.
The playlist default duration for static files in seconds.
Whether the playlist should be created in a paused state.
The playlist restrictions
If items is an empty list, null or not specified, creates an empty playlist. If items is list of Playable items, those will be inserted in the same order as the list.
The created Playlist
Move content to a different FOLDER. Requires a token with content:write permission.
The content unique identifier.
The destination FOLDER unique identifier.
The updated content
Play content on demand. Requires a token with player:write and content:read permission.
The player unique identifier.
Content that should be played. The player must already have this content published to it, otherwise playback will simply be ignored.
By default the playback of content starts as soon as this mutation is called, interrupting whatever is currently playing, be it either scheduled or other on demand campaign.
How many times should this content should be played (or enqueued, if the action is not PLAY). Default is 1. Ignored if action is PLAYFOREVER.
If the player is not online retry command for this many seconds. From 5 seconds to 1 hour. Default is 120 seconds.
Parameters added to the playback that gets forwarded to the player
Whether the player was online and command was delivered.
Publishes an item (campaign, playlist or content) to a player loop. Requires a token with content:write permission.
The Player Loop ID
The content to append to the player loop
Sets the duration, in seconds, of static items like images and apps. Can be used to overwrite the duration of videos.
The pause state for this Playable in the player loop.
The content restrictions
The Player Loop item appended to the player loop
Requests a reboot to the player. Requires a token with player:write permission.
The player unique identifier.
The updated Player
Reject row chances from the data feed. Requires a token with content:write permission.
The Data Feed unique identifier.
A list of rows to have their pending changes rejected. Check DataFeedRowStatus for more info.
The updated Data Feed.
Remove content. If the given content is a FOLDER then all content within it will also be removed. Requires a token with content:write permission.
The content unique identifier.
The result
Removes all occurrences of a playlist item by its name. Requires a token with content:write permission.
The playlist ID
The content name
The result
Remove rows from the Data Feed. Requires a token with content:write permission.
The Data Feed unique identifier.
A list of rows to be deleted. Check DataFeedRowStatus for more info.
The row status is set to pending when requested to be removed. Default is false.
The updated Data Feed.
Removes a playlist item from a playlist. Requires a token with content:write permission.
The playlist item ID
The result
Removes the player from a group. Requires a token with player:write permission.
The player unique identifier.
The player group unique identifier.
The updated Player
The player group which the player was removed from
Remove a tag from a player. Requires a token with player:write permission.
The player unique identifier.
The tag to be removed
The updated Player
Removes a user from a user group. Requires a token with user:write permission.
The user group unique identifier.
The user unique identifier.
The user group that was updated.
Rename content. The new name cannot start with a leading period (.) or contain any slashes (/). Requires a token with content:write permission.
The content unique identifier.
The new content name
The updated content
Causes the player to immediately stop playing content that was played on-demand and return to playing content from its primary loop. Requires a token with player:write permission.
The player unique identifier.
If the player is not online retry command for this many seconds. From 5 seconds to 1 hour. Default is 120 seconds.
Whether the player was online and command was delivered.
Toggles the paused state for a campaign. Requires a token with content:write permission.
The Campaign ID
The pause state
The updated Campaign
Updates a campaign restriction. Requires a token with content:write permission.
The Campaign ID
The restrictions to be set
The updated Campaign
Updates a content permission. Grants or removes permissions to a user or user group on a content. Contents permissions will be replaced by the given list of permissions. At least one target must be provided, userId or groupId. Requires a token with user:write permission.
The content unique identifier.
The user unique identifier.
The user group unique identifier.
A list of permissions to be granted to the user or group on the content. The list can`t be null, and if the list is empty all permissions will be removed.
The updated Content.
Update a Data Feed. When calling this mutation, you need provide at least one field to be updated, any data provided will overwrite the existing Data Feed field. Requires a token with content:write permission.
The Data Feed Column unique identifier.
A new name for the data feed. Omit it to keep the existing name.
A new list of tags for the data feed. Omit it to keep the existing tags.
Any of the desired changes to columns.
Any of the desired changes to rows.
The updated Data Feed.
Update multiples Data Feed rows to same value. Requires a token with content:write permission.
The Data Feed unique identifier.
A list of rows to have their values updated. Check DataFeedRowStatus for more info.
The row values to be updated. Each key is the column ID. E.g. { columnId: value, new1: value1 }
The row status is set to "P_UPDATE" when requested to be updated. Default is false.
The updated Data Feed.
Updates a player to the latest version. Requires a token with player:write permission.
The player unique identifier.
The updated Player
Updates the player custom attribute. Requires a token with player:write permission.
The player unique identifier.
The custom attribute to be updated
The updated Player
Updates a player group permission. Grants or removes permissions to a user or user group. Player Group permissions will be replaced by the given list of permissions. At least one target must be provided, userId or groupId. Requires a token with user:write permission.
The player group unique identifier.
The user unique identifier.
The user group unique identifier.
A list of permissions to be granted to the user or group on the player. The list can`t be null, and if the list is empty all permissions will be removed.
The updated Player Group.
Updates the player group tags. Requires a token with player:write permission.
The player group unique identifier.
The tags to be set
The updated Player Group
Updates a player permission. Grants or removes permissions to a user or user group on a content. Player permissions will be replaced by the given list of permissions. At least one target must be provided, userId or groupId. Requires a token with user:write permission.
The player unique identifier.
The user unique identifier.
The user group unique identifier.
A list of permissions to be granted to the user or group on the player. The list can`t be null, and if the list is empty all permissions will be removed.
The updated Player.
Updates the player tags. Requires a token with player:write permission.
The player unique identifier.
The tags to be set
The updated Player
Update the playlist state in a single mutation, update its pause state, restrictions and items inside the playlist. Requires a token with content:write permission.
The Playlist ID
The pause state for this Playable in the Playlist.
The content restrictions
If items is an empty list, removes all current items from the playlist, making it empty. If items is list of Playable items, it will replace the current list of items in the playlist. If items is null or not specified, the playlist items will be left untouched.
The Playlist
Toggles the paused state for a playlist item. Requires a token with content:write permission.
The Playlist Item ID
The pause state
The updated Playlist Item
Updates a playlist item restriction. Requires a token with content:write permission.
The Playlist Item ID
The restrictions to be set
The updated Playlist Item
Toggles the paused state for a playlist. Requires a token with content:write permission.
The Playlist ID
The pause state
The updated Playlist
Updates a playlist restriction. Requires a token with content:write permission.
The Playlist ID
The restrictions to be set
The updated Playlist
Updates the default folder of a user. The user can still access the Home folder regardless of this setting. Requires a token with user:write.
The user unique identifier.
The folder unique identifier. Permissions must be granted to the user on the selected folder before setting it as default. If this field is null, the default folder setting will be removed and the user will use by default the Home folder.
The updated User.
Updates the default folder of all users from a user group. The users can still access the Home folder regardless of the default folder. This will not set the default folder to the user group, but to the current users in the group. Requires a token with user:write.
The user group unique identifier.
The folder unique identifier. Before setting a folder as default, ensure the users from the group have been granted the necessary permissions on the selected folder. If this field is null, the default folder setting will be removed and the users will use by default the Home folder.
The updated User Group.
Updates a user group permissions. Grants or removes permissions to a user group. Requires a token with user:write permission.
The user group unique identifier.
A list of permissions to be granted to the user group. The list can`t be null.
A list of permissions to be removed from the user group. The list can`t be null
The updated User Group.
Updates a user permission. Grants or removes permissions to a user. Requires a token with user:write permission.
The user unique identifier.
A list of permissions to be granted to the user. The list can`t be null.
A list of permissions to be removed from the user. The list can`t be null
The updated User.
Information about deleting a data feed row.
The row ID.
Exepcted version of the row. Will fail the mutation if the current version is different from the one given here. Leave it blank to skip conflict detection.
If true the row status is set to "P_DELETE" instead of being deleted immediately. Defaults to false.
The row ID to be updated.
The row ID.
Exepcted version of the row. Will fail the mutation if the current version is different from the one given here. Leave it blank to skip conflict detection.
The row to be updated with the new value.
The row ID.
Exepcted version of the row. Will fail the mutation if the current version is different from the one given here. Leave it blank to skip conflict detection.
The row values to be updated. Each key is the column ID. E.g. { columnId: value, new1: value1 }
If true the row status is set to "P_UPDATE" instead of being updated immediately. Defaults to false.
The row to be inserted with the new values.
The row values to be created. Each key is the column ID. E.g. { columnId: value, new1: value1 }
Position where this row should be inserted. Leave it blank for the row to be inserted at the end.
The row status is set to pending for create.
Lists of actions to be performed on the Data Feed.
A list of insert operations to be performed.
A list of update operations to be performed.
A list of delete operations to be performed.
A list of rows to have their status changes approved. Check DataFeedRowStatus for more info.
A list of rows to have their pending changes rejected. Check DataFeedRowStatus for more info.
The new column to be create with some configurations.
The column ID. New columns must be given a temporary ID prefixed with new, like new1, new2, etc. This temporary ID can be referenced by rows when creating columns and inserting or updating rows on the same mutation.
The column name. Must be unique inside then given data feed.
Makes the column required, so all rows need to have a non-null value for this column.
The column max length, used only when kind == "TEXT"
The column note.
The column to be updated with the new configurations.
The existing column ID.
The column name. Leave null to keep existing name.
The column note. Leave null to keep existing note.
Lists of operations to be performed on the Data Feed columns.
A list of create operations to be performed.
A list of update operations to be performed.
A list of delete operations to be performed.
The Playlist ID
The pause state for this Playable in the Playlist.
The content restrictions
If items is an empty list, removes all current items from the playlist, making it empty. If items is list of Playable items, it will replace the current list of items in the playlist. If items is null or not specified, the playlist items will be left untouched.
Represents a Playable and how it should be inserted into the Playlist ID or PlayerLoop ID.
The content to added to the Playlist
Sets the duration, in seconds, of static items like images and apps. Can be used to overwrite the duration of videos.
The pause state for this Playable in this position of the Playlist.
The restrictions on this Playable in this position of the Playlist.
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.