OBJECT

Query

Queries are used to retrieve data. If you're new to our API, try the me query to explore the information you have access to. Hit ctrl-space at any time to activate field completion hints, and mouse over a field or parameter to see its documentation.

link GraphQL Schema definition

  • type Query {
  • # Retrieve a list of temporal data objects.
  • #
  • # Arguments
  • # organizationId: Organization ID to get TDOs for. Defaults to
  • # the user's own organization.
  • # You can only retrieves content for your own organizations or organizations
  • # that have shared data with yours.
  • # applicationId: Application ID (an authorization construct that
  • # maps directly to organization ID)
  • # to get TDOs for. Defaults to the user's own organization.
  • # id: Provide an ID to retrieve a single specific TDO.
  • # offset: Provide an offset to skip to a certain element in the
  • # result, for paging.
  • # limit: Specify maximum number of results to retrieve in this
  • # result. Page size.
  • # sourceId: Optionally, specify a source ID. TDOs ingested from
  • # this source will
  • # be returned.
  • # scheduledJobId: Optionally, specify a scheduled job ID. TDOs
  • # ingested under this
  • # scheduled job will be returned.
  • # sampleMedia: Whether to retrieve only tdos with the specified
  • # sampleMedia value
  • # includePublic: Whether to retrieve public data that is not part
  • # of the user's organization.
  • # The default is false. Pass true to include public data in the result set.
  • # orderBy:
  • # orderDirection:
  • # dateTimeFilter: Provide optional filters against any date/time
  • # field to filter
  • # objects within a given time window.
  • # Matching objects must meet all of the given conditions.
  • # mentionId: Retrieve TDOs associated with the given mention
  • temporalDataObjects(
  • organizationId: ID,
  • applicationId: ID,
  • id: ID,
  • offset: Int,
  • limit: Int,
  • sourceId: ID,
  • scheduledJobId: ID,
  • sampleMedia: Boolean,
  • includePublic: Boolean,
  • orderBy: TemporalDataObjectOrderBy,
  • orderDirection: OrderDirection,
  • dateTimeFilter: [TemporalDataObjectDateTimeFilter!],
  • mentionId: ID
  • ): TDOList
  • # Retrieve a single temporal data object
  • #
  • # Arguments
  • # id: the TDO ID
  • temporalDataObject(id: ID!): TemporalDataObject
  • # flows
  • #
  • # Arguments
  • # id:
  • flows(id: ID): FlowList
  • # Retrieve a single Asset
  • #
  • # Arguments
  • # id: The asset ID
  • asset(id: ID!): Asset
  • # Retrieve a single Widget
  • #
  • # Arguments
  • # id: The widget ID
  • widget(id: ID!): Widget
  • # Retrieve clone job entries
  • #
  • # Arguments
  • # id: Provide an ID to retrieve a single specific clone request.
  • # applicationId: Application ID to get clone requests for.
  • # Defaults to the user's own application.
  • # offset:
  • # limit:
  • cloneRequests(id: ID, applicationId: ID, offset: Int, limit: Int): CloneRequestList
  • # Retrieve engines
  • #
  • # Arguments
  • # id: Provide an ID to retrieve a single specific engine.
  • # ids:
  • # categoryId: Provide a category ID to filter by engine category.
  • # category: provide a category name or ID to filter by engine
  • # category
  • # state: Provide a list of states to filter by engine state.
  • # owned: If true, return only engines owned by the user's
  • # organization.
  • # libraryRequired: If true, return only engines that require a
  • # library.
  • # createsTDO: If true, return only engines that create their own
  • # TDO.
  • # If false, return only engines that do not create a TDO.
  • # If not set, return either.
  • # name: Provide a name, or part of a name, to search by engine
  • # name
  • # offset: Specify maximum number of results to retrieve in this
  • # result. Page size.
  • # limit: Specify maximum number of results to retrieve in this
  • # result.
  • # filter: Filters for engine attributes
  • # orderBy: Provide a list of EngineSortField to sort by.
  • # edgeVersion: Edge version to filter
  • engines(
  • id: ID,
  • ids: [ID!],
  • categoryId: String,
  • category: String,
  • state: [EngineState],
  • owned: Boolean,
  • libraryRequired: Boolean,
  • createsTDO: Boolean,
  • name: String,
  • offset: Int,
  • limit: Int,
  • filter: EngineFilter,
  • orderBy: [EngineSortField],
  • edgeVersion: Int
  • ): EngineList
  • # Retrieve a single engine by ID
  • #
  • # Arguments
  • # id: Provide the engine ID
  • engine(id: ID!): Engine
  • # Arguments
  • # id: Provide the build ID
  • engineBuild(id: ID!): Build
  • # Retrieve engine categories
  • #
  • # Arguments
  • # id: Provide an ID to retrieve a single specific engine
  • # category.
  • # ids: Provide multiple IDs to retrieve engine categories
  • # name: Provide a name, or part of one, to search by category
  • # name
  • # type: Return all categories of an engine type
  • # offset: Specify maximum number of results to retrieve in this
  • # result. Page size.
  • # limit: Specify maximum number of results to retrieve in this
  • # result.
  • engineCategories(
  • id: ID,
  • ids: [ID!],
  • name: String,
  • type: String,
  • offset: Int,
  • limit: Int
  • ): EngineCategoryList
  • # Retrieve a specific engine category
  • #
  • # Arguments
  • # id: Supply the ID of the engine category to retrieve
  • engineCategory(id: ID!): EngineCategory
  • # Retrieve jobs
  • #
  • # Arguments
  • # hasTargetTDO:
  • # id: Provide an ID to retrieve a single specific job.
  • # status: Provide a list of status strings to filter by status
  • # applicationStatus:
  • # offset: Provide an offset to skip to a certain element in the
  • # result, for paging.
  • # limit: Specify the maximum number of results to included in
  • # this response, or page size.
  • # applicationId: Provide an application ID to filter jobs for a
  • # given application.
  • # Defaults to the user's own application.
  • # targetId: Provide a target ID to get the set of jobs running
  • # against a particular TDO.
  • # clusterId: Provide a cluster ID to get the jobs running on a
  • # specific cluster
  • # scheduledJobIds: Provide a list of scheduled job IDs to get
  • # jobs associated with the scheduled jobs
  • # hasScheduledJobId: Return only jobs that are (true) or are not
  • # (false) associated with a scheduled job
  • # orderBy: Provide sort information. The default is to sort by
  • # createdDateTime descending.
  • # dateTimeFilter: Filter by date/time field
  • # applicationIds: Provide list of application IDs to filter jobs.
  • # Defaults to the user's own application.
  • # engineIds: Provide a list of engine IDs to filter for jobs
  • # that contain tasks for the specified engines.
  • # engineCategoryIds: Provide a list of engine category IDs to
  • # filter for jobs
  • # that contain tasks for engines in the specific categories.
  • jobs(
  • hasTargetTDO: Boolean,
  • id: ID,
  • status: [JobStatusFilter!],
  • applicationStatus: String,
  • offset: Int,
  • limit: Int,
  • applicationId: ID,
  • targetId: ID,
  • clusterId: ID,
  • scheduledJobIds: [ID!],
  • hasScheduledJobId: Boolean,
  • orderBy: [JobSortField!],
  • dateTimeFilter: [JobDateTimeFilter!],
  • applicationIds: [ID],
  • engineIds: [ID!],
  • engineCategoryIds: [ID!]
  • ): JobList
  • # Retrieve a single job
  • #
  • # Arguments
  • # id: the job ID
  • job(id: ID!): Job
  • # Retrieve a single task by ID
  • #
  • # Arguments
  • # id: Provide the task ID.
  • task(id: ID!): Task
  • # Retrieve entity identifier types
  • #
  • # Arguments
  • # id: Provide an ID to retrieve a single specific entity
  • # identifier type.
  • # offset: Provide an offset to skip to a certain element in the
  • # result, for paging.
  • # limit: Specify maximum number of results to retrieve in this
  • # result. Page size.
  • entityIdentifierTypes(id: ID, offset: Int, limit: Int): EntityIdentifierTypeList
  • # Arguments
  • # id: Provide the entity identifier type ID
  • entityIdentifierType(id: ID!): EntityIdentifierType
  • # Retrieve all library types
  • #
  • # Arguments
  • # id: Provide an ID to retrieve a single specific library type.
  • # offset: Provide an offset to skip to a certain element in the
  • # result, for paging.
  • # limit: Specify maximum number of results to retrieve in this
  • # result. Page size.
  • libraryTypes(id: ID, offset: Int, limit: Int): LibraryTypeList
  • # Retrieve a single library type
  • #
  • # Arguments
  • # id: Provide an ID to retrieve a single specific library type.
  • libraryType(id: ID): LibraryType
  • # Retrieve libraries and entities
  • #
  • # Arguments
  • # id: Provide an ID to retrieve a single specific library.
  • # name: Provide a name string to search by name.
  • # type: Provide the name or ID of a library to search for
  • # libraries
  • # that contain that type.
  • # entityIdentifierTypeIds: Provide the id of an entity identifier
  • # type to search for libraries that correlate
  • # to that type.
  • # includeOwnedOnly: Specify true if only libraries owned by the
  • # user's organization
  • # should be returned. Otherwise, shared libraries will be included.
  • # offset: Provide an offset to skip to a certain element in the
  • # result, for paging.
  • # limit: Specify maximum number of results to retrieve in this
  • # result. Page size.
  • # orderBy: Specify a field to order by
  • # orderDirection: Specify the direction to order by
  • libraries(
  • id: ID,
  • name: String,
  • type: String,
  • entityIdentifierTypeIds: [String!],
  • includeOwnedOnly: Boolean,
  • offset: Int,
  • limit: Int,
  • orderBy: LibraryOrderBy,
  • orderDirection: OrderDirection
  • ): LibraryList
  • # Retrieve a specific library
  • #
  • # Arguments
  • # id: Provide a library ID.
  • library(id: ID!): Library
  • # Retrieve a specific library engine model
  • #
  • # Arguments
  • # id: Provide the library engine model ID
  • libraryEngineModel(id: ID!): LibraryEngineModel
  • # Retrieve a specific entity
  • #
  • # Arguments
  • # id: Provide an entity ID.
  • entity(id: ID!): Entity
  • # Retrieve a list of entities across libraries
  • #
  • # Arguments
  • # ids: Provide a list of entity IDs to retrieve those entities
  • # libraryIds: Provide a list of library IDs to retrieve entities
  • # across
  • # multiple libraries.
  • # isPublished:
  • # identifierTypeId:
  • # name:
  • # offset:
  • # limit:
  • # orderBy:
  • # orderDirection:
  • entities(
  • ids: [ID!],
  • libraryIds: [ID!],
  • isPublished: Boolean,
  • identifierTypeId: ID,
  • name: String,
  • offset: Int,
  • limit: Int,
  • orderBy: LibraryEntityOrderBy,
  • orderDirection: OrderDirection
  • ): EntityList
  • # Retrieve library configuration
  • #
  • # Arguments
  • # id: Provide configuration id
  • libraryConfiguration(id: ID!): LibraryConfiguration
  • # Retrieve applications. These are custom applications integrated into
  • # the Veritone platform using the VDA framework.
  • #
  • # Arguments
  • # id: Provide an ID to retrieve a single specific application.
  • # status: Provide a status, such as "draft" or "active"
  • # owned: If true, return only applications owned by the user's
  • # organization.
  • # offset: Provide an offset to skip to a certain element in the
  • # result, for paging.
  • # limit: Specify maximum number of results to retrieve in this
  • # result. Page size.
  • applications(
  • id: ID,
  • status: ApplicationStatus,
  • owned: Boolean,
  • offset: Int,
  • limit: Int
  • ): ApplicationList
  • # Retrieve organizations
  • #
  • # Arguments
  • # id: Provide an ID to retrieve a single specific organization.
  • # offset: Provide an offset to skip to a certain element in the
  • # result, for paging.
  • # limit: Specify maximum number of results to retrieve in this
  • # result. Page size.
  • # kvpProperty: Provide a property from the organization kvp to
  • # filter the organization list.
  • # kvpValue: Provide value to for the kvpFeature filter.
  • # If not present the filter becomes kvpProperty existence filter
  • # name: Optionally, supply a string for string match
  • # nameMatch: Supply the type of string match to apply.
  • organizations(
  • id: ID,
  • offset: Int,
  • limit: Int,
  • kvpProperty: String,
  • kvpValue: String,
  • name: String,
  • nameMatch: StringMatch
  • ): OrganizationList
  • # Retrieve a single organization
  • #
  • # Arguments
  • # id: The organization ID
  • # TODO take application ID as well as org ID
  • organization(id: ID!): Organization
  • # Retrieve permissions
  • #
  • # Arguments
  • # id: Provide an ID to retrieve a single specific permission.
  • # name:
  • # offset: Provide an offset to skip to a certain element in the
  • # result, for paging.
  • # limit: Specify maximum number of results to retrieve in this
  • # result. Page size.
  • permissions(id: ID, name: String, offset: Int, limit: Int): PermissionList
  • # Retrieve users
  • #
  • # Arguments
  • # id: Provide an ID to retrieve a single specific user.
  • # A user ID is a string in UUID format.
  • # ids: Provide IDs to retrieve multiple users by ID.
  • # name: Provide a name, or part of one, to search by name.
  • # organizationIds: Provide a list of organization IDs to filter
  • # your search by organization.
  • # offset: Provide an offset to skip to a certain element in the
  • # result, for paging.
  • # limit: Specify maximum number of results to retrieve in this
  • # result. Page size.
  • # includeAllOrgUsers: Include all organization users.
  • # dateTimeFilter: Filter by date/time field
  • # status: Filter by account status
  • users(
  • id: ID,
  • ids: [ID],
  • name: String,
  • organizationIds: [ID],
  • offset: Int,
  • limit: Int,
  • includeAllOrgUsers: Boolean,
  • dateTimeFilter: [UsersDateTimeFilter!],
  • status: UserStatus
  • ): UserList
  • # Retrieve an individual user
  • #
  • # Arguments
  • # id: The user ID.
  • # A user ID is a string in UUID format.
  • # organizationIds:
  • user(id: ID!, organizationIds: [ID]): User
  • # Retrieve user's organization API tokens
  • tokens: [Token]
  • # Retrieve information for the current logged-in user
  • me: User
  • # Retrieve groups
  • #
  • # Arguments
  • # id: Provide an ID to retrieve a specific group by ID
  • # ids: Provide IDs to retrieve multiple groups by ID
  • # name: Provide a name, or part of one, to search for groups by
  • # name
  • # organizationIds: Provide a list of organization IDs to retrieve
  • # groups defined
  • # within certain organizations.
  • # offset: Provide an offset to skip to a certain element in the
  • # result, for paging.
  • # limit: Specify maximum number of results to retrieve in this
  • # result. Page size.
  • groups(id: ID, ids: [ID], name: String, organizationIds: [ID], offset: Int, limit: Int): GroupList
  • # Retrieve a single mention
  • #
  • # Arguments
  • # mentionId: The mention ID
  • # limit: Comments pagination - limit
  • # offset: Comments pagination - limit
  • # userId: The user who owns the mention.
  • mention(mentionId: ID!, limit: Int, offset: Int, userId: String): Mention
  • # Retrieve a shared mention
  • #
  • # Arguments
  • # shareId: share token
  • sharedMention(shareId: ID!): SharedMention
  • # Search for mentions across an index.
  • # This query requires a user token.
  • #
  • # Arguments
  • # search: JSON structure containing the search query.
  • # See https://docs.veritone.com/#/apis/search-quickstart for full details on the
  • # search query syntax
  • searchMentions(search: JSONData!): SearchResult
  • # Search for media across an index.
  • # This query requires a user token.
  • #
  • # Arguments
  • # search: JSON structure containing the search query.
  • # See https://docs.veritone.com/#/apis/search-quickstart for full details on the
  • # search query syntax
  • searchMedia(search: JSONData!): SearchResult
  • # Retrieve the root folders for an organization
  • #
  • # Arguments
  • # type: The type of root folder to retrieve
  • rootFolders(type: RootFolderType): [Folder]
  • # Retrieve a single folder. Used to navigate the folder tree structure.
  • #
  • # Arguments
  • # id: Provide an ID to retrieve a single specific user.
  • folder(id: ID!): Folder
  • # Arguments
  • # query: An elastic query for audit events
  • # orderDirection:
  • # application: Filter logs by a specific application
  • # terms: Term filters to filter documents by properties in the
  • # payload
  • # limit:
  • # offset:
  • auditEvents(
  • query: JSONData,
  • orderDirection: OrderDirection,
  • application: String,
  • terms: [JSONData!],
  • limit: Int,
  • offset: Int
  • ): AuditEventList!
  • # Arguments
  • # ids: Tree Object Ids
  • # rootFolderType:
  • folderOverview(ids: [ID!]!, rootFolderType: RootFolderType): FolderOverview
  • # Arguments
  • # ids: Tree Object Ids
  • # rootFolderType:
  • folderSummaryDetails(
  • ids: [ID!]!,
  • rootFolderType: RootFolderType
  • ): [FolderSummaryDetail]
  • # Retrieve a single application
  • #
  • # Arguments
  • # id: The application ID
  • application(id: ID!): Application
  • # Retrieve a list of schemas for structured data ingestions
  • #
  • # Arguments
  • # id: Id of a schema to retrieve
  • # ids: Ids of schemas to retrieve
  • # dataRegistryId: Specify the id of the DataRegistry to get
  • # schemas
  • # status: Specify one or more statuses to filter by schema status
  • # majorVersion: Specify a major version to filter schemas
  • # name: Specify a data registry name to filter schemas
  • # nameMatch: The strategy used to find data registry name
  • # limit: Limit
  • # offset: Offset
  • # orderBy: Specify one or more fields and direction to order
  • # results
  • schemas(
  • id: ID,
  • ids: [ID!],
  • dataRegistryId: ID,
  • status: [SchemaStatus!],
  • majorVersion: Int,
  • name: String,
  • nameMatch: StringMatch,
  • limit: Int,
  • offset: Int,
  • orderBy: [SchemaOrder]
  • ): SchemaList
  • # Arguments
  • # id:
  • schema(id: ID!): Schema
  • # Arguments
  • # dataRegistryVersion:
  • # search:
  • # limit: Limit
  • # offset: Offset
  • schemaProperties(
  • dataRegistryVersion: [DataRegistryVersion!],
  • search: String,
  • limit: Int,
  • offset: Int
  • ): SchemaPropertyList
  • # Retrieve a structured data object
  • #
  • # Arguments
  • # id: Supply the ID of the structured data object to retrieve.
  • # This will override filters.
  • # schemaId: Schema Id for the structured data object to retrieve
  • structuredData(id: ID!, schemaId: ID!): StructuredData
  • # Retrieve a structured data object
  • #
  • # Arguments
  • # id: Supply the ID of the structured data object to retrieve.
  • # This will override filters.
  • # schemaId: Schema Id for the structured data object to retrieve
  • structuredDataObject(id: ID!, schemaId: ID!): StructuredData
  • # Retrieve a paginated list of structured data object
  • #
  • # Arguments
  • # id: Supply the ID of the structured data object to retrieve.
  • # This will override filters.
  • # ids: List of Ids of the structured data objects to retrieve.
  • # This will override filters.
  • # schemaId: Schema Id for the structured data object to retrieve
  • # orderBy:
  • # limit:
  • # offset:
  • # owned:
  • # filter: Query to filter SDO. Supports operations such as and,
  • # or, eq, gt, lt, etc.
  • # TODO link to syntax documentation
  • structuredDataObjects(
  • id: ID,
  • ids: [ID!],
  • schemaId: ID!,
  • orderBy: [StructuredDataOrderBy!],
  • limit: Int,
  • offset: Int,
  • owned: Boolean,
  • filter: JSONData
  • ): StructuredDataList
  • # Returns information about the GraphQL server, useful
  • # for diagnostics. This data is primarily used by Veritone
  • # development, and some fields may be restricted to Veritone administrators.
  • graphqlServiceInfo: GraphQLServiceInfo
  • # Returns a signed writable S3 URL. A client can then
  • # upload to this URL with an HTTP PUT without providing
  • # any additional authorization (_note_: it must be a PUT.
  • # A POST will fail.)
  • #
  • # Arguments
  • # key: Optional key of the object to generate a writable
  • # URL for. If not provided, a new, unique key will
  • # be generated. If a key is provided and resembles a file name
  • # (with extension delimited by .), a UUID will be inserted
  • # into the file name, leaving the extension intact.
  • # If a key is provided and does not resemble
  • # a file name, a UUID will be appended.
  • # type: Optional type of resource, such as `asset`, `thumbnail`,
  • # `discovery-analytics` or `preview`
  • # path: Optional extended path information. If the uploaded
  • # content will be contained
  • # within a container such as a `TemporalDataObject` (for `asset`) or `Library`
  • # (for `entityIdentifier`), the ID of the object should be provided here.
  • # expiresInSeconds: Optional expiresInSeconds custom expiration
  • # to signedUrlExpires
  • # Max expiresInSeconds up to 604800
  • # organizationId: Optional organization ID. Normally this value
  • # is computed by the server
  • # based on the authorization token used for the request.
  • # Is is used only by Veritone platform components.
  • getSignedWritableUrl(
  • key: String,
  • type: String,
  • path: String,
  • expiresInSeconds: Int,
  • organizationId: ID
  • ): WritableUrlInfo
  • # Return writable storage URLs in bulk.
  • # A maximum of 1000 can be created in one call.
  • # See `getSignedWritableUrl` for details on usage of the
  • # response contents.
  • #
  • # Arguments
  • # number: Number of signed URLs to return
  • # type: Optional type of resource, such as `asset`, `thumbnail`,
  • # or `preview`
  • # path: Optional extended path information. If the uploaded
  • # content will be contained
  • # within a container such as a `TemporalDataObject` (for `asset`) or `Library`
  • # (for `entityIdentifier`), the ID of the object should be provided here.
  • # organizationId: Optional organization ID. Normally this value
  • # is computed by the server
  • # based on the authorization token used for the request.
  • # Is is used only by Veritone platform components.
  • getSignedWritableUrls(
  • number: Int!,
  • type: String,
  • path: String,
  • organizationId: ID
  • ): [WritableUrlInfo!]!
  • myRights: RightsListing
  • # Retrieve the shared folders for an organization
  • sharedFolders: [Folder]
  • # Arguments
  • # id:
  • # maxStopDateTime:
  • # minStopDateTime:
  • # minStartDateTime:
  • # maxStartDateTime:
  • # name:
  • # offset:
  • # limit:
  • # orderBy:
  • # orderDirection:
  • # isDisabled: Set `true` to include only disabled watchlist or
  • # `false` to include only enabled watchlists. By default,
  • # both are included.
  • watchlists(
  • id: ID,
  • maxStopDateTime: DateTime,
  • minStopDateTime: DateTime,
  • minStartDateTime: DateTime,
  • maxStartDateTime: DateTime,
  • name: String,
  • offset: Int,
  • limit: Int,
  • orderBy: WatchlistOrderBy,
  • orderDirection: OrderDirection,
  • isDisabled: Boolean
  • ): WatchlistList
  • # Arguments
  • # id:
  • watchlist(id: ID!): Watchlist
  • mentionStatusOptions: [MentionStatus!]!
  • # Arguments
  • # id:
  • # ids:
  • # name:
  • # nameMatch:
  • # offset:
  • # limit:
  • # orderBy:
  • # orderDirection:
  • # filterByOwnership:
  • dataRegistries(
  • id: ID,
  • ids: [ID!],
  • name: String,
  • nameMatch: StringMatch,
  • offset: Int,
  • limit: Int,
  • orderBy: DataRegistryOrderBy,
  • orderDirection: OrderDirection,
  • filterByOwnership: SchemaOwnership
  • ): DataRegistryList
  • # Arguments
  • # id:
  • dataRegistry(id: ID!): DataRegistry
  • # Arguments
  • # id:
  • subscription(id: ID!): Subscription!
  • # Arguments
  • # id:
  • cognitiveSearch(id: ID!): CognitiveSearch!
  • # Arguments
  • # id:
  • # name:
  • # mentionId:
  • # offset:
  • # limit:
  • collections(id: ID, name: String, mentionId: ID, offset: Int, limit: Int): CollectionList!
  • # Arguments
  • # id:
  • collection(id: ID!): Collection!
  • # Arguments
  • # folderId:
  • # mentionId:
  • collectionMention(folderId: ID!, mentionId: ID!): CollectionMention!
  • # Retrieve a list of collection mentions
  • # Specify at least one of folderId or mentionId
  • #
  • # Arguments
  • # folderId:
  • # mentionId:
  • # orderBy:
  • # limit:
  • # offset:
  • collectionMentions(
  • folderId: ID,
  • mentionId: ID,
  • orderBy: CollectionMentionOrderBy,
  • limit: Int,
  • offset: Int
  • ): CollectionMentionList!
  • # Arguments
  • # id:
  • # watchlistId: Get mentions created from the specified watchlist
  • # sourceId: Get mentions associated with the specified source
  • # sourceTypeId: Get mentions associated with sources of the
  • # specified source type
  • # tdoId: Get mentions associated directly with the specific TDO
  • # dateTimeFilter: Specify date/time filters against mention
  • # fields.
  • # Querying for mentions can be expensive. If the query does not
  • # include a filter by `id`, `tdoId`, `sourceId`, `watchlistId`, or
  • # a user-provided `dateTimeFilter`, a default filter of the
  • # past 7 days is applied.
  • # orderBy: Set order information on the query. Multiple fields
  • # are supported.
  • # offset:
  • # limit:
  • # folderId: Provide a folder ID to filter by collection
  • mentions(
  • id: ID,
  • watchlistId: ID,
  • sourceId: ID,
  • sourceTypeId: ID,
  • tdoId: ID,
  • dateTimeFilter: [MentionDateTimeFilter!],
  • orderBy: [MentionOrderBy!],
  • offset: Int,
  • limit: Int,
  • folderId: ID
  • ): MentionList
  • # Retrieves engine results by TDO and engine ID or by job ID.
  • #
  • # Arguments
  • # tdoId: Provide the ID of the TDO containing engine results to
  • # retrieve.
  • # If this parameter is used, engineIds or engineCategoryIds must also be set.
  • # Results for _only_ the specified TDO will be returned.
  • # sourceId: Provide the ID of the Source containing engine
  • # results to retrieve.
  • # If this parameter is used, engineIds or engineCategoryIds must also be set.
  • # This takes priority over tdoId.
  • # engineIds: Provide one or more engine IDs to retrieve engine
  • # results by
  • # ID. This parameter is mandatory if tdoId is used, but optional
  • # if jobId or engineCategory is used.
  • # engineCategoryIds: Provide one or more category IDs to get all
  • # results from that categroy.
  • # jobId: Provide a job ID to retrieve engine results for the job.
  • # mentionId: Provide a mention ID to retrieve engine results for
  • # the mention.
  • # startOffsetMs: Start offset ms for the results.
  • # stopOffsetMs: End offset ms for the results.
  • # startDate: Start date for the results. Takes priority over
  • # startOffsetMs.
  • # stopDate: End date for the results. Takes priority over
  • # stopOffsetMs.
  • # ignoreUserEdited: Whether or not to exclude user edited engine
  • # results. Defaults to false.
  • # fallbackTdoId: A TDO ID can be provided for use if the provided
  • # `sourceId` and/or
  • # `mentionId` parameters do not resolve to a logical set of TDOs.
  • # Depending on parameter settings and available data,
  • # results from other TDOs can be included in the response.
  • engineResults(
  • tdoId: ID,
  • sourceId: ID,
  • engineIds: [ID!],
  • engineCategoryIds: [ID!],
  • jobId: ID,
  • mentionId: ID,
  • startOffsetMs: Int,
  • stopOffsetMs: Int,
  • startDate: DateTime,
  • stopDate: DateTime,
  • ignoreUserEdited: Boolean,
  • fallbackTdoId: ID
  • ): EngineResultList
  • # Arguments
  • # id:
  • trigger(id: ID!): Trigger
  • triggers: [Trigger]
  • # Fetch all saved searches that the current user has made
  • # Fetch all saved searches that have been shared with
  • # the current users organization
  • # Include any saved searches that the user has created
  • #
  • # Arguments
  • # offset:
  • # limit:
  • # includeShared:
  • # filterByName:
  • # orderBy:
  • # orderDirection:
  • savedSearches(
  • offset: Int,
  • limit: Int,
  • includeShared: Boolean,
  • filterByName: String,
  • orderBy: SavedSearchOrderBy,
  • orderDirection: OrderDirection
  • ): SavedSearchList!
  • # Retrieve a list of export requests
  • #
  • # Arguments
  • # id: Provide an ID to retrieve a single export request
  • # offset: Provide an offset to skip to a certain element in the
  • # result, for paging.
  • # limit: Specify maximum number of results to retrieve in this
  • # result. Page size.
  • # status: Provide a list of status options to filter by status
  • # event: Provide an event to retrieve export request. Should be
  • # 'exportRequest' or 'mentionExportRequest'
  • # Default value is 'exportRequest'
  • exportRequests(
  • id: ID,
  • offset: Int,
  • limit: Int,
  • status: [ExportRequestStatus!],
  • event: ExportRequestEvent
  • ): ExportRequestList!
  • # Arguments
  • # id:
  • # event: Provide an event to retrieve export request. Should be
  • # 'exportRequest' or 'mentionExportRequest'
  • # Default value is 'exportRequest'
  • exportRequest(id: ID!, event: ExportRequestEvent): ExportRequest!
  • # Retrieve a event by id
  • #
  • # Arguments
  • # id:
  • event(id: ID!): Event!
  • # Retrieve a list of events by application
  • #
  • # Arguments
  • # application: Provide an application to retrieve all its events.
  • # Use 'system' to list all public system events.
  • # offset: Provide an offset to skip to a certain element in the
  • # result, for paging.
  • # limit: Specify maximum number of results to retrieve in this
  • # result. Page size.
  • events(application: String!, offset: Int, limit: Int): EventList!
  • # Retrieve a list of subscriptions by organization
  • #
  • # Arguments
  • # ids: The event subscription ids
  • # eventName: The name of the event
  • # eventType: The type of event, such as `mention`, `job`,
  • # `engine`.
  • # offset: Provide an offset to skip to a certain element in the
  • # result, for paging.
  • # limit: Specify maximum number of results to retrieve in this
  • # result. Page size.
  • eventSubscriptions(
  • ids: [ID!],
  • eventName: String,
  • eventType: String,
  • offset: Int,
  • limit: Int
  • ): EventSubscriptionList!
  • # Arguments
  • # id:
  • eventSubscription(id: ID!): EventSubscription!
  • # Arguments
  • # id:
  • eventActionTemplate(id: ID!): EventActionTemplate
  • # Arguments
  • # ownerApplicationId: The application id
  • # inputType: use "event" for now. In the future, we allow
  • # additional input_type types. For example, a schedule or a tweet.
  • # actionType: Either "job", "webhook", "sms", "email". Future
  • # action_type could be "gql" where action is purely a function call.
  • # offset: Provide an offset to skip to a certain element in the
  • # result, for paging.
  • # limit: Specify maximum number of results to retrieve in this
  • # result. Page size.
  • eventActionTemplates(
  • ownerApplicationId: ID,
  • inputType: EventActionTemplateInputType,
  • actionType: EventActionTemplateActionType,
  • offset: Int,
  • limit: Int
  • ): EventActionTemplateList!
  • # Arguments
  • # id:
  • eventCustomRule(id: ID!): EventCustomRule
  • # Arguments
  • # offset: the offset to skip to a certain element in the result
  • # limit: the maximum number of rows in the results
  • eventCustomRules(offset: Int, limit: Int): EventCustomRuleList!
  • # This query returns information about time zones recognized by this
  • # server. The information is static and does not change.
  • timeZones: [TimeZone!]!
  • # Examine entries from the audit log. All operations that modify data are
  • # written to the audit log. Only entries for the user's own organization
  • # can be queried.
  • # All queries are bracketed by a time window. A default time window is applied
  • # if the `toDateTime` and/or `fromDateTime` parameters are not provided.
  • # The maximum time window length is 30 days.
  • # Only Veritone and organization administrators can use this query.
  • #
  • # Arguments
  • # toDateTime: Date/time up to which entries will be returned. In
  • # other words, the
  • # end of the query time window.
  • # Defaults to the current time.
  • # fromDateTime: Date/time from which entries will be returned. In
  • # other words, the
  • # start of the query time window.
  • # Defaults to the `toDateTime` minus 7 days.
  • # organizationId: Organization ID to query records for. This
  • # value can only be used by
  • # Veritone administrators. Any value provided by user administrators will
  • # be ignored.
  • # userName: User name on audit entry. Must be exact match.
  • # clientIpAddress: IP address of the client that generated the
  • # audit action. Must be exact match.
  • # clientUserAgent: HTTP user agent of the client that generated
  • # the audit action. Must be exact match.
  • # eventType: The event type, such as `Create`, `Update`, or
  • # `Delete`.
  • # Must be exact match.
  • # objectId: The ID of the object involved in the audit action.
  • # The format of this ID
  • # varies by object type. Must be exact match.
  • # objectType: The type of the object involved in the audit
  • # action, such as `Watchlist`
  • # or `TemporalDataObject`. Must be exact match.
  • # success: Whether or not the action was successful.
  • # id: The unique ID of an audit log entry. Multiple values can be
  • # provided.
  • # offset: Offset into result set, for paging.
  • # limit: Limit on result size, for paging (page size). Audit
  • # queries are
  • # lightweight so the default of 100 is higher than the default offset
  • # used elsewhere in the API.
  • # orderBy: Order information. Default is order by
  • # `createdDateTime` descending.
  • auditLog(
  • toDateTime: DateTime,
  • fromDateTime: DateTime,
  • organizationId: ID,
  • userName: String,
  • clientIpAddress: String,
  • clientUserAgent: String,
  • eventType: String,
  • objectId: ID,
  • objectType: String,
  • success: Boolean,
  • id: [ID!],
  • offset: Int,
  • limit: Int,
  • orderBy: [AuditLogOrderBy!]
  • ): AuditLogEntryList!
  • # Get the media share by media shareId
  • #
  • # Arguments
  • # id:
  • mediaShare(id: ID!): MediaShare!
  • # Retrieve a shared collection
  • #
  • # Arguments
  • # shareId: share token
  • sharedCollection(shareId: ID!): SharedCollection
  • # Retrieve shared collection history records
  • #
  • # Arguments
  • # ids: Provide an ID to retrieve a single history record
  • # folderId: Provide a folder ID to filter by collection
  • # shareId: Provide a share ID to filter by share ID
  • # offset: Specify maximum number of results to retrieve in this
  • # result. Page size.
  • # limit: Specify maximum number of results to retrieve in this
  • # result.
  • sharedCollectionHistory(
  • ids: [ID!],
  • folderId: ID,
  • shareId: String,
  • offset: Int,
  • limit: Int
  • ): SharedCollectionHistoryList!
  • # Retrieve Workflow Metric of the current user's organization
  • workflowMetric: WorkflowMetric!
  • dailyTaskMetrics: DailyTaskMetricsList!
  • # Retrieve Veritone Workflow instance status by id
  • #
  • # Arguments
  • # workflowRuntimeId:
  • workflowRuntime(workflowRuntimeId: ID!): WorkflowRuntimeResponse!
  • # Get a specific workflowRuntimeData based on dataKey
  • #
  • # Arguments
  • # workflowRuntimeId: Unique id of the workflow instance
  • # storageKey: The unique id to rertrieve a single workflow data
  • # storageKeyPrefix: A prefix filter used to return a set of
  • # workflow data
  • # items whose dataKey starts with dataKeyPrefix
  • # offset: Offset for paging
  • # limit: Limit on result size, for paging (page size).
  • # workflowRuntimeData can be arbitrary large therefore smaller paging shoulf be
  • # preffered
  • workflowRuntimeStorageData(
  • workflowRuntimeId: ID!,
  • storageKey: String,
  • storageKeyPrefix: String,
  • offset: Int,
  • limit: Int
  • ): WorkflowRuntimeStorageDataList!
  • # Get list process templates by id or current organizationId
  • #
  • # Arguments
  • # id:
  • # offset:
  • # limit:
  • processTemplates(id: ID, offset: Int, limit: Int): ProcessTemplateList!
  • # Get process templates by id
  • #
  • # Arguments
  • # id:
  • processTemplate(id: ID!): ProcessTemplate!
  • # Get creative by id with current organizationId
  • #
  • # Arguments
  • # id:
  • creative(id: ID!): Creative!
  • # Retrieve list of engine classes
  • #
  • # Arguments
  • # id: Provide an ID to retrieve a single specific engine class.
  • # name: Provide a name, or part of one, to search by class name
  • # offset: Specify maximum number of results to retrieve in this
  • # result. Page size.
  • # limit: Specify maximum number of results to retrieve in this
  • # result.
  • engineClasses(id: ID, name: String, offset: Int, limit: Int): EngineClassList
  • # Retrieve a specific engine class
  • #
  • # Arguments
  • # id: Supply the ID of the engine class to retrieve
  • engineClass(id: ID!): EngineClass
  • # Arguments
  • # offset:
  • # limit:
  • benchmarkJobs(offset: Int, limit: Int): BenchmarkJobs
  • # Arguments
  • # id:
  • benchmarkJob(id: ID!): BenchmarkJob
  • # Returns all custom dashboards created by user
  • #
  • # Arguments
  • # offset: Provide an offset to skip to a certain element in the
  • # result, for paging.
  • # limit: Specify maximum number of results to retrieve in this
  • # result. Page size.
  • # hostAppId: Include only dashboards created by specific
  • # host_app_id
  • customDashboards(offset: Int, limit: Int, hostAppId: ID): CustomDashboardList
  • # Returns custom dashboard by id
  • #
  • # Arguments
  • # id:
  • customDashboard(id: ID!): CustomDashboard
  • }

link Require by

This element is not required by anyone