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

1type Query {
2
3# Retrieve a list of temporal data objects.
4#
5# Arguments
6# organizationId: Organization ID to get TDOs for. Defaults to
7# the user's own organization.
8# You can only retrieves content for your own organizations or organizations
9# that have shared data with yours.
10# applicationId: Application ID (an authorization construct that
11# maps directly to organization ID)
12# to get TDOs for. Defaults to the user's own organization.
13# id: Provide an ID to retrieve a single specific TDO.
14# offset: Provide an offset to skip to a certain element in the
15# result, for paging.
16# limit: Specify maximum number of results to retrieve in this
17# result. Page size.
18# sourceId: Optionally, specify a source ID. TDOs ingested from
19# this source will
20# be returned.
21# programId: Optionally, specify a program ID. TDOs belong to
22# this program will
23# be returned.
24# scheduledJobId: Optionally, specify a scheduled job ID. TDOs
25# ingested under this
26# scheduled job will be returned.
27# sampleMedia: Whether to retrieve only tdos with the specified
28# sampleMedia value
29# includePublic: Whether to retrieve public data that is not part
30# of the user's organization.
31# The default is false. Pass true to include public data in the result set.
32# dateTimeFilter: Provide optional filters against any date/time
33# field to filter
34# objects within a given time window.
35# Matching objects must meet all of the given conditions.
36# mentionId: Retrieve TDOs associated with the given mention
37temporalDataObjects(
38organizationId: ID,
39applicationId: ID,
40id: ID,
41offset: Int,
42limit: Int,
43sourceId: ID,
44programId: ID,
45scheduledJobId: ID,
46sampleMedia: Boolean,
47includePublic: Boolean,
48orderBy: TemporalDataObjectOrderBy,
49orderDirection: OrderDirection,
50dateTimeFilter: [TemporalDataObjectDateTimeFilter!],
51mentionId: ID
52): TDOList
53
54# Retrieve a single temporal data object
55#
56# Arguments
57# id: the TDO ID
58temporalDataObject(id: ID!): TemporalDataObject
59
60# Retrieve a single Asset
61#
62# Arguments
63# id: The asset ID
64asset(id: ID!): Asset
65
66# Retrieve multiple assets
67#
68# Arguments
69# ids: List of asset ids
70# contentTypes: Filter assets with content type included in the
71# list
72# See https://www.iana.org/assignments/media-types/media-types.xhtml
73# assetTypes: Filter assets with assetType included in the list
74# See https://docs.veritone.com/#/apis/tutorials/asset-types for list of values.
75# sourceEngineIds: Filter by source engine.
76# Not all assets have associated engineId, ex. media assets
77# createdDateFilter: Filter by created date
78# Note createdDateFilter.filter is required, but currently ignored
79# offset: Offset to skip to a certain element in the result, for
80# paging.
81# limit: Maximum number of results to retrieve in this result.
82# Page size.
83# scrollId: Use this field when sequentially iterating over the
84# assets list
85# This is required for when offset + limit exceeds 10000.
86# The value of this field is set from the response of the first/previous
87# assets query
88assets(
89ids: [ID!],
90contentTypes: [String!],
91assetTypes: [String!],
92sourceEngineIds: [String!],
93createdDateFilter: TemporalDataObjectDateTimeFilter,
94offset: Int,
95limit: Int,
96scrollId: String
97): AssetScrollList
98
99# Retrieve a single Widget
100#
101# Arguments
102# id: The widget ID
103widget(id: ID!): Widget
104
105# Retrieve clone job entries
106#
107# Arguments
108# id: Provide an ID to retrieve a single specific clone request.
109# applicationId: Application ID to get clone requests for.
110# Defaults to the user's own application.
111cloneRequests(id: ID, applicationId: ID, offset: Int, limit: Int): CloneRequestList
112
113# Retrieve most recent builds
114#
115# Arguments
116# buildStatus: Engine build status:
117# offset: Specify maximum number of results to retrieve in this
118# result. Page size.
119# limit: Specify maximum number of results to retrieve in this
120# result.
121# orderBy: Set order information on the query. Multiple fields
122# are supported.
123# Default order by modifiedDateTime desc
124recentBuilds(
125buildStatus: [BuildStatus!],
126offset: Int,
127limit: Int,
128orderBy: [EngineBuildOrderBy!]
129): BuildList
130
131# Retrieve engine overview
132engineOverview: EngineOverview
133
134# Retrieve engines
135#
136# Arguments
137# id: Provide an ID to retrieve a single specific engine.
138# categoryId: Provide a category ID to filter by engine category.
139# category: provide a category name or ID to filter by engine
140# category
141# state: Provide a list of states to filter by engine state.
142# owned: If true, return only engines owned by the user's
143# organization.
144# libraryRequired: If true, return only engines that require a
145# library.
146# createsTDO: If true, return only engines that create their own
147# TDO.
148# If false, return only engines that do not create a TDO.
149# If not set, return either.
150# name: Provide a name, or part of a name, to search by engine
151# name
152# offset: Specify maximum number of results to retrieve in this
153# result. Page size.
154# limit: Specify maximum number of results to retrieve in this
155# result.
156# filter: Filters for engine attributes
157# orderBy: Provide a list of EngineSortField to sort by.
158# edgeVersion: Edge version to filter
159engines(
160id: ID,
161ids: [ID!],
162categoryId: String,
163category: String,
164state: [EngineState],
165owned: Boolean,
166libraryRequired: Boolean,
167createsTDO: Boolean,
168name: String,
169offset: Int,
170limit: Int,
171filter: EngineFilter,
172orderBy: [EngineSortField],
173edgeVersion: Int
174): EngineList
175
176# Retrieve a single engine by ID
177#
178# Arguments
179# id: Provide the engine ID
180engine(id: ID!): Engine
181
182# Arguments
183# id: Provide the build ID
184engineBuild(id: ID!): Build
185
186# Retrieve engine categories
187#
188# Arguments
189# id: Provide an ID to retrieve a single specific engine
190# category.
191# ids: Provide multiple IDs to retrieve engine categories
192# name: Provide a name, or part of one, to search by category
193# name
194# type: Return all categories of an engine type
195# offset: Specify maximum number of results to retrieve in this
196# result. Page size.
197# limit: Specify maximum number of results to retrieve in this
198# result.
199engineCategories(
200id: ID,
201ids: [ID!],
202name: String,
203type: String,
204offset: Int,
205limit: Int
206): EngineCategoryList
207
208# Retrieve a specific engine category
209#
210# Arguments
211# id: Supply the ID of the engine category to retrieve
212engineCategory(id: ID!): EngineCategory
213
214# Retrieve jobs
215#
216# Arguments
217# id: Provide an ID to retrieve a single specific job.
218# status: Provide a list of status strings to filter by status
219# offset: Provide an offset to skip to a certain element in the
220# result, for paging.
221# limit: Specify the maximum number of results to included in
222# this response, or page size.
223# applicationId: Provide an application ID to filter jobs for a
224# given application.
225# Defaults to the user's own application.
226# targetId: Provide a target ID to get the set of jobs running
227# against a particular TDO.
228# clusterId: Provide a cluster ID to get the jobs running on a
229# specific cluster
230# scheduledJobIds: Provide a list of scheduled job IDs to get
231# jobs associated with the scheduled jobs
232# hasScheduledJobId: Return only jobs that are (true) or are not
233# (false) associated with a scheduled job
234# orderBy: Provide sort information. The default is to sort by
235# createdDateTime descending.
236# dateTimeFilter: Filter by date/time field
237# applicationIds: Provide list of application IDs to filter jobs.
238# Defaults to the user's own application.
239# engineIds: Provide a list of engine IDs to filter for jobs
240# that contain tasks for the specified engines.
241# engineCategoryIds: Provide a list of engine category IDs to
242# filter for jobs
243# that contain tasks for engines in the specific categories.
244jobs(
245hasTargetTDO: Boolean,
246id: ID,
247status: [JobStatusFilter!],
248applicationStatus: String,
249offset: Int,
250limit: Int,
251applicationId: ID,
252targetId: ID,
253clusterId: ID,
254scheduledJobIds: [ID!],
255hasScheduledJobId: Boolean,
256orderBy: [JobSortField!],
257dateTimeFilter: [JobDateTimeFilter!],
258applicationIds: [ID],
259engineIds: [ID!],
260engineCategoryIds: [ID!]
261): JobList
262
263# Retrieve a single job by ID
264#
265# Arguments
266# id: the job ID.
267job(id: ID!): Job
268
269# Retrieve a single task by ID
270#
271# Arguments
272# id: Provide the task ID.
273task(id: ID!): Task
274
275# Retrieve entity identifier types
276#
277# Arguments
278# id: Provide an ID to retrieve a single specific entity
279# identifier type.
280# offset: Provide an offset to skip to a certain element in the
281# result, for paging.
282# limit: Specify maximum number of results to retrieve in this
283# result. Page size.
284entityIdentifierTypes(id: ID, offset: Int, limit: Int): EntityIdentifierTypeList
285
286# Arguments
287# id: Provide the entity identifier type ID
288entityIdentifierType(id: ID!): EntityIdentifierType
289
290# Retrieve all library types
291#
292# Arguments
293# id: Provide an ID to retrieve a single specific library type.
294# offset: Provide an offset to skip to a certain element in the
295# result, for paging.
296# limit: Specify maximum number of results to retrieve in this
297# result. Page size.
298libraryTypes(id: ID, offset: Int, limit: Int): LibraryTypeList
299
300# Retrieve a single library type
301#
302# Arguments
303# id: Provide an ID to retrieve a single specific library type.
304libraryType(id: ID): LibraryType
305
306# Retrieve libraries and entities
307#
308# Arguments
309# id: Provide an ID to retrieve a single specific library.
310# name: Provide a name string to search by name.
311# type: Provide the name or ID of a library to search for
312# libraries
313# that contain that type.
314# entityIdentifierTypeIds: Provide the id of an entity identifier
315# type to search for libraries that correlate
316# to that type.
317# includeOwnedOnly: Specify true if only libraries owned by the
318# user's organization
319# should be returned. Otherwise, shared libraries will be included.
320# offset: Provide an offset to skip to a certain element in the
321# result, for paging.
322# limit: Specify maximum number of results to retrieve in this
323# result. Page size.
324# orderBy: Specify a field to order by
325# orderDirection: Specify the direction to order by
326libraries(
327id: ID,
328name: String,
329type: String,
330entityIdentifierTypeIds: [String!],
331includeOwnedOnly: Boolean,
332offset: Int,
333limit: Int,
334orderBy: LibraryOrderBy,
335orderDirection: OrderDirection
336): LibraryList
337
338# Retrieve a specific library
339#
340# Arguments
341# id: Provide a library ID.
342library(id: ID!): Library
343
344# Retrieve a specific library engine model
345#
346# Arguments
347# id: Provide the library engine model ID
348libraryEngineModel(id: ID!): LibraryEngineModel
349
350# Retrieve a specific entity
351#
352# Arguments
353# id: Provide an entity ID.
354entity(id: ID!): Entity
355
356# Retrieve a list of entities across libraries
357#
358# Arguments
359# ids: Provide a list of entity IDs to retrieve those entities
360# libraryIds: Provide a list of library IDs to retrieve entities
361# across
362# multiple libraries.
363entities(
364ids: [ID!],
365libraryIds: [ID!],
366isPublished: Boolean,
367identifierTypeId: ID,
368name: String,
369offset: Int,
370limit: Int,
371orderBy: LibraryEntityOrderBy,
372orderDirection: OrderDirection
373): EntityList
374
375# Retrieve library configuration
376#
377# Arguments
378# id: Provide configuration id
379libraryConfiguration(id: ID!): LibraryConfiguration
380
381# Retrieve applications. These are custom applications integrated into
382# the Veritone platform using the VDA framework.
383#
384# Arguments
385# id: Provide an ID to retrieve a single specific application.
386# status: Provide a status, such as "draft" or "active"
387# owned: If true, return only applications owned by the user's
388# organization.
389# orgId: For super admin user only, if specified, the query
390# returns applications for this orgId.
391# offset: Provide an offset to skip to a certain element in the
392# result, for paging.
393# limit: Specify maximum number of results to retrieve in this
394# result. Page size.
395applications(
396id: ID,
397status: ApplicationStatus,
398owned: Boolean,
399orgId: ID,
400offset: Int,
401limit: Int
402): ApplicationList
403
404# Retrieve organizations
405#
406# Arguments
407# id: Provide an ID to retrieve a single specific organization.
408# offset: Provide an offset to skip to a certain element in the
409# result, for paging.
410# limit: Specify maximum number of results to retrieve in this
411# result. Page size.
412# kvpProperty: Provide a property from the organization kvp to
413# filter the organization list.
414# kvpValue: Provide value to for the kvpFeature filter.
415# If not present the filter becomes kvpProperty existence filter
416# name: Optionally, supply a string for string match
417# nameMatch: Supply the type of string match to apply.
418organizations(
419id: ID,
420offset: Int,
421limit: Int,
422kvpProperty: String,
423kvpValue: String,
424name: String,
425nameMatch: StringMatch
426): OrganizationList
427
428# Retrieve a single organization
429#
430# Arguments
431# id: The organization ID
432# TODO take application ID as well as org ID
433organization(id: ID!): Organization
434
435# Retrieve organizations to which the user belongs
436#
437# Arguments
438# userName: User name to uniquely identify a user
439# offset: Provide an offset to skip to a certain element in the
440# result, for paging.
441# limit: Specify maximum number of results to retrieve in this
442# result. Page size.
443myOrganizations(userName: String, offset: Int, limit: Int): OrganizationList
444
445# Retrieve permissions
446#
447# Arguments
448# id: Provide an ID to retrieve a single specific permission.
449# offset: Provide an offset to skip to a certain element in the
450# result, for paging.
451# limit: Specify maximum number of results to retrieve in this
452# result. Page size.
453permissions(id: ID, name: String, offset: Int, limit: Int): PermissionList
454
455# Retrieve users
456#
457# Arguments
458# id: Provide an ID to retrieve a single specific user.
459# A user ID is a string in UUID format.
460# ids: Provide IDs to retrieve multiple users by ID.
461# name: Provide a name, or part of one, to search by name.
462# organizationIds: Provide a list of organization IDs to filter
463# your search by organization.
464# offset: Provide an offset to skip to a certain element in the
465# result, for paging.
466# limit: Specify maximum number of results to retrieve in this
467# result. Page size.
468# includeAllOrgUsers: Include all organization users.
469# dateTimeFilter: Filter by date/time field
470# status: Filter by account status
471users(
472id: ID,
473ids: [ID],
474name: String,
475organizationIds: [ID],
476offset: Int,
477limit: Int,
478includeAllOrgUsers: Boolean,
479dateTimeFilter: [UsersDateTimeFilter!],
480status: UserStatus
481): UserList
482
483# Retrieve an individual user
484#
485# Arguments
486# id: The user ID.
487# A user ID is a string in UUID format.
488user(id: ID!, organizationIds: [ID]): User
489
490# Retrieve user's organization API tokens
491tokens: [Token]
492
493# Retrieve information for the current logged-in user
494me: User
495
496# Retrieve groups
497#
498# Arguments
499# id: Provide an ID to retrieve a specific group by ID
500# ids: Provide IDs to retrieve multiple groups by ID
501# name: Provide a name, or part of one, to search for groups by
502# name
503# organizationIds: "
504# Provide a list of organization IDs to retrieve groups defined
505# within certain organizations.
506# offset: Provide an offset to skip to a certain element in the
507# result, for paging.
508# limit: Specify maximum number of results to retrieve in this
509# result. Page size.
510groups(id: ID, ids: [ID], name: String, organizationIds: [ID], offset: Int, limit: Int): GroupList
511
512# Retrieve a single mention
513#
514# Arguments
515# mentionId: The mention ID
516# limit: Comments pagination - limit
517# offset: Comments pagination - limit
518# userId: The user who owns the mention.
519mention(mentionId: ID!, limit: Int, offset: Int, userId: String): Mention
520
521# Retrieve a shared mention
522#
523# Arguments
524# shareId: share token
525sharedMention(shareId: ID!): SharedMention
526
527# Search for mentions across an index.
528# This query requires a user token.
529# Known Issues:
530# - Offset can not go past 10,000. To get around this, the best practice is to
531# keep updating the start time of the query based on the last mention you have
532# processed.
533#
534# Arguments
535# search: JSON structure containing the search query.
536# See https://docs.veritone.com/#/apis/search-quickstart for full details on the
537# search query syntax
538searchMentions(search: JSONData!): SearchResult
539
540# Search for media across an index.
541# This query requires a user token.
542#
543# Arguments
544# search: JSON structure containing the search query.
545# See https://docs.veritone.com/#/apis/search-quickstart for full details on the
546# search query syntax
547searchMedia(search: JSONData!): SearchResult
548
549# Retrieve the root folders for an organization
550#
551# Arguments
552# type: The type of root folder to retrieve
553rootFolders(type: RootFolderType): [Folder]
554
555# Retrieve a single folder. Used to navigate the folder tree structure.
556#
557# Arguments
558# id: Provide an ID to retrieve a single specific user.
559folder(id: ID!): Folder
560
561# Arguments
562# query: An elastic query for audit events
563# application: Filter logs by a specific application
564# terms: Term filters to filter documents by properties in the
565# payload
566auditEvents(
567query: JSONData,
568orderDirection: OrderDirection,
569application: String,
570terms: [JSONData!],
571limit: Int,
572offset: Int
573): AuditEventList!
574
575# Arguments
576# ids: Tree Object Ids
577folderOverview(ids: [ID!]!, rootFolderType: RootFolderType): FolderOverview
578
579# Arguments
580# ids: Tree Object Ids
581folderSummaryDetails(
582ids: [ID!]!,
583rootFolderType: RootFolderType
584): [FolderSummaryDetail]
585
586# Retrieve a single application
587#
588# Arguments
589# id: The application ID
590application(id: ID!): Application
591
592# Retrieve a list of schemas for structured data ingestions
593#
594# Arguments
595# id: Id of a schema to retrieve
596# ids: Ids of schemas to retrieve
597# dataRegistryId: Specify the id of the DataRegistry to get
598# schemas
599# status: Specify one or more statuses to filter by schema status
600# majorVersion: Specify a major version to filter schemas
601# name: Specify a data registry name to filter schemas
602# nameMatch: The strategy used to find data registry name
603# limit: Limit
604# offset: Offset
605# orderBy: Specify one or more fields and direction to order
606# results
607schemas(
608id: ID,
609ids: [ID!],
610dataRegistryId: ID,
611status: [SchemaStatus!],
612majorVersion: Int,
613name: String,
614nameMatch: StringMatch,
615limit: Int,
616offset: Int,
617orderBy: [SchemaOrder]
618): SchemaList
619
620# Retrieve a schema for structured data ingestions
621#
622# Arguments
623# id: Supply the ID of the schema to retrieve
624schema(id: ID!): Schema
625
626# Arguments
627# limit: Limit
628# offset: Offset
629schemaProperties(
630dataRegistryVersion: [DataRegistryVersion!],
631search: String,
632limit: Int,
633offset: Int
634): SchemaPropertyList
635
636# Retrieve a structured data object
637#
638# Arguments
639# id: Supply the ID of the structured data object to retrieve.
640# This will override filters.
641# schemaId: Schema Id for the structured data object to retrieve
642structuredData(id: ID!, schemaId: ID!): StructuredData
643
644# Retrieve a structured data object
645#
646# Arguments
647# id: Supply the ID of the structured data object to retrieve.
648# This will override filters.
649# schemaId: Schema Id for the structured data object to retrieve
650structuredDataObject(id: ID!, schemaId: ID!): StructuredData
651
652# Retrieve a paginated list of structured data object
653#
654# Arguments
655# id: Supply the ID of the structured data object to retrieve.
656# This will override filters.
657# ids: List of Ids of the structured data objects to retrieve.
658# This will override filters.
659# schemaId: Schema Id for the structured data object to retrieve
660# filter: Query to filter SDO. Supports operations such as and,
661# or, eq, gt, lt, etc.
662# TODO link to syntax documentation
663structuredDataObjects(
664id: ID,
665ids: [ID!],
666schemaId: ID!,
667orderBy: [StructuredDataOrderBy!],
668limit: Int,
669offset: Int,
670owned: Boolean,
671filter: JSONData
672): StructuredDataList
673
674# Returns information about the GraphQL server, useful
675# for diagnostics. This data is primarily used by Veritone
676# development, and some fields may be restricted to Veritone administrators.
677graphqlServiceInfo: GraphQLServiceInfo
678
679# Returns a signed writable S3 URL. A client can then
680# upload to this URL with an HTTP PUT without providing
681# any additional authorization (_note_: it must be a PUT.
682# A POST will fail.)
683#
684# Arguments
685# key: Optional key of the object to generate a writable
686# URL for. If not provided, a new, unique key will
687# be generated. If a key is provided and resembles a file name
688# (with extension delimited by .), a UUID will be inserted
689# into the file name, leaving the extension intact.
690# If a key is provided and does not resemble
691# a file name, a UUID will be appended.
692# type: Optional type of resource, such as `asset`, `thumbnail`,
693# `discovery-analytics` or `preview`
694# path: Optional extended path information. If the uploaded
695# content will be contained
696# within a container such as a `TemporalDataObject` (for `asset`) or `Library`
697# (for `entityIdentifier`), the ID of the object should be provided here.
698# expiresInSeconds: Optional expiresInSeconds custom expiration
699# to signedUrlExpires
700# Max expiresInSeconds up to 604800
701# organizationId: Optional organization ID. Normally this value
702# is computed by the server
703# based on the authorization token used for the request.
704# Is is used only by Veritone platform components.
705getSignedWritableUrl(
706key: String,
707type: String,
708path: String,
709expiresInSeconds: Int,
710organizationId: ID
711): WritableUrlInfo
712
713# Return writable storage URLs in bulk.
714# A maximum of 1000 can be created in one call.
715# See `getSignedWritableUrl` for details on usage of the
716# response contents.
717#
718# Arguments
719# number: Number of signed URLs to return
720# type: Optional type of resource, such as `asset`, `thumbnail`,
721# or `preview`
722# path: Optional extended path information. If the uploaded
723# content will be contained
724# within a container such as a `TemporalDataObject` (for `asset`) or `Library`
725# (for `entityIdentifier`), the ID of the object should be provided here.
726# organizationId: Optional organization ID. Normally this value
727# is computed by the server
728# based on the authorization token used for the request.
729# Is is used only by Veritone platform components.
730getSignedWritableUrls(
731number: Int!,
732type: String,
733path: String,
734organizationId: ID
735): [WritableUrlInfo!]!
736
737myRights: RightsListing
738
739# Retrieve the shared folders for an organization
740sharedFolders: [Folder]
741
742# Arguments
743# isDisabled: Set `true` to include only disabled watchlist or
744# `false` to include only enabled watchlists. By default,
745# both are included.
746watchlists(
747id: ID,
748maxStopDateTime: DateTime,
749minStopDateTime: DateTime,
750minStartDateTime: DateTime,
751maxStartDateTime: DateTime,
752name: String,
753offset: Int,
754limit: Int,
755orderBy: WatchlistOrderBy,
756orderDirection: OrderDirection,
757isDisabled: Boolean
758): WatchlistList
759
760watchlist(id: ID!): Watchlist
761
762mentionStatusOptions: [MentionStatus!]!
763
764dataRegistries(
765id: ID,
766ids: [ID!],
767name: String,
768nameMatch: StringMatch,
769offset: Int,
770limit: Int,
771orderBy: DataRegistryOrderBy,
772orderDirection: OrderDirection,
773filterByOwnership: SchemaOwnership
774): DataRegistryList
775
776dataRegistry(id: ID!): DataRegistry
777
778subscription(id: ID!): Subscription!
779
780cognitiveSearch(id: ID!): CognitiveSearch!
781
782collections(id: ID, name: String, mentionId: ID, offset: Int, limit: Int): CollectionList!
783
784collection(id: ID!): Collection!
785
786collectionMention(folderId: ID!, mentionId: ID!): CollectionMention!
787
788# Retrieve a list of collection mentions
789# Specify at least one of folderId or mentionId
790collectionMentions(
791folderId: ID,
792mentionId: ID,
793orderBy: CollectionMentionOrderBy,
794limit: Int,
795offset: Int
796): CollectionMentionList!
797
798# Arguments
799# watchlistId: Get mentions created from the specified watchlist
800# sourceId: Get mentions associated with the specified source
801# sourceTypeId: Get mentions associated with sources of the
802# specified source type
803# tdoId: Get mentions associated directly with the specific TDO
804# dateTimeFilter: Specify date/time filters against mention
805# fields.
806# Querying for mentions can be expensive. If the query does not
807# include a filter by `id`, `tdoId`, `sourceId`, `watchlistId`, or
808# a user-provided `dateTimeFilter`, a default filter of the
809# past 7 days is applied.
810# orderBy: Set order information on the query. Multiple fields
811# are supported.
812# folderId: Provide a folder ID to filter by collection
813mentions(
814id: ID,
815watchlistId: ID,
816sourceId: ID,
817sourceTypeId: ID,
818tdoId: ID,
819dateTimeFilter: [MentionDateTimeFilter!],
820orderBy: [MentionOrderBy!],
821offset: Int,
822limit: Int,
823folderId: ID
824): MentionList
825
826# Retrieves engine results by TDO and engine ID or by job ID.
827#
828# Arguments
829# tdoId: Provide the ID of the TDO containing engine results to
830# retrieve.
831# If this parameter is used, engineIds or engineCategoryIds must also be set.
832# Results for _only_ the specified TDO will be returned.
833# sourceId: Provide the ID of the Source containing engine
834# results to retrieve.
835# If this parameter is used, engineIds or engineCategoryIds must also be set.
836# This takes priority over tdoId.
837# engineIds: Provide one or more engine IDs to retrieve engine
838# results by
839# ID. This parameter is mandatory if tdoId is used, but optional
840# if jobId or engineCategory is used.
841# engineCategoryIds: Provide one or more category IDs to get all
842# results from that categroy.
843# jobId: Provide a job ID to retrieve engine results for the job.
844# mentionId: Provide a mention ID to retrieve engine results for
845# the mention.
846# startOffsetMs: Start offset ms for the results.
847# stopOffsetMs: End offset ms for the results.
848# startDate: Start date for the results. Takes priority over
849# startOffsetMs.
850# stopDate: End date for the results. Takes priority over
851# stopOffsetMs.
852# ignoreUserEdited: Whether or not to exclude user edited engine
853# results. Defaults to false.
854# fallbackTdoId: A TDO ID can be provided for use if the provided
855# `sourceId` and/or
856# `mentionId` parameters do not resolve to a logical set of TDOs.
857# Depending on parameter settings and available data,
858# results from other TDOs can be included in the response.
859engineResults(
860tdoId: ID,
861sourceId: ID,
862engineIds: [ID!],
863engineCategoryIds: [ID!],
864jobId: ID,
865mentionId: ID,
866startOffsetMs: Int,
867stopOffsetMs: Int,
868startDate: DateTime,
869stopDate: DateTime,
870ignoreUserEdited: Boolean,
871fallbackTdoId: ID
872): EngineResultList
873
874trigger(id: ID!): Trigger
875
876triggers: [Trigger]
877
878# Fetch all saved searches that the current user has made
879# Fetch all saved searches that have been shared with
880# the current users organization
881# Include any saved searches that the user has created
882savedSearches(
883offset: Int,
884limit: Int,
885includeShared: Boolean,
886filterByName: String,
887orderBy: SavedSearchOrderBy,
888orderDirection: OrderDirection
889): SavedSearchList!
890
891# Retrieve a list of export requests
892#
893# Arguments
894# id: Provide an ID to retrieve a single export request
895# offset: Provide an offset to skip to a certain element in the
896# result, for paging.
897# limit: Specify maximum number of results to retrieve in this
898# result. Page size.
899# status: Provide a list of status options to filter by status
900# event: Provide an event to retrieve export request. Should be
901# 'exportRequest' or 'mentionExportRequest'
902# Default value is 'exportRequest'
903exportRequests(
904id: ID,
905offset: Int,
906limit: Int,
907status: [ExportRequestStatus!],
908event: ExportRequestEvent
909): ExportRequestList!
910
911# Arguments
912# event: Provide an event to retrieve export request. Should be
913# 'exportRequest' or 'mentionExportRequest'
914# Default value is 'exportRequest'
915exportRequest(id: ID!, event: ExportRequestEvent): ExportRequest!
916
917# Retrieve a event by id
918event(id: ID!): Event!
919
920# Retrieve a list of events by application
921#
922# Arguments
923# application: Provide an application to retrieve all its events.
924# Use 'system' to list all public system events.
925# offset: Provide an offset to skip to a certain element in the
926# result, for paging.
927# limit: Specify maximum number of results to retrieve in this
928# result. Page size.
929events(application: String!, offset: Int, limit: Int): EventList!
930
931# Retrieve a list of subscriptions by organization
932#
933# Arguments
934# ids: The event subscription ids
935# eventName: The name of the event
936# eventType: The type of event, such as `mention`, `job`,
937# `engine`.
938# offset: Provide an offset to skip to a certain element in the
939# result, for paging.
940# limit: Specify maximum number of results to retrieve in this
941# result. Page size.
942eventSubscriptions(
943ids: [ID!],
944eventName: String,
945eventType: String,
946offset: Int,
947limit: Int
948): EventSubscriptionList!
949
950eventSubscription(id: ID!): EventSubscription!
951
952eventActionTemplate(id: ID!): EventActionTemplate
953
954# Arguments
955# ownerApplicationId: The application id
956# inputType: use "event" for now. In the future, we allow
957# additional input_type types. For example, a schedule or a tweet.
958# actionType: Either "job", "webhook", "sms", "email". Future
959# action_type could be "gql" where action is purely a function call.
960# offset: Provide an offset to skip to a certain element in the
961# result, for paging.
962# limit: Specify maximum number of results to retrieve in this
963# result. Page size.
964eventActionTemplates(
965ownerApplicationId: ID,
966inputType: EventActionTemplateInputType,
967actionType: EventActionTemplateActionType,
968offset: Int,
969limit: Int
970): EventActionTemplateList!
971
972eventCustomRule(id: ID!): EventCustomRule
973
974# Arguments
975# offset: the offset to skip to a certain element in the result
976# limit: the maximum number of rows in the results
977eventCustomRules(offset: Int, limit: Int): EventCustomRuleList!
978
979# This query returns information about time zones recognized by this
980# server. The information is static and does not change.
981timeZones: [TimeZone!]!
982
983# Examine entries from the audit log. All operations that modify data are
984# written to the audit log. Only entries for the user's own organization
985# can be queried.
986# All queries are bracketed by a time window. A default time window is applied
987# if the `toDateTime` and/or `fromDateTime` parameters are not provided.
988# The maximum time window length is 30 days.
989# Only Veritone and organization administrators can use this query.
990#
991# Arguments
992# toDateTime: Date/time up to which entries will be returned. In
993# other words, the
994# end of the query time window.
995# Defaults to the current time.
996# fromDateTime: Date/time from which entries will be returned. In
997# other words, the
998# start of the query time window.
999# Defaults to the `toDateTime` minus 7 days.
1000# organizationId: Organization ID to query records for. This
1001# value can only be used by
1002# Veritone administrators. Any value provided by user administrators will
1003# be ignored.
1004# userName: User name on audit entry. Must be exact match.
1005# clientIpAddress: IP address of the client that generated the
1006# audit action. Must be exact match.
1007# clientUserAgent: HTTP user agent of the client that generated
1008# the audit action. Must be exact match.
1009# eventType: The event type, such as `Create`, `Update`, or
1010# `Delete`.
1011# Must be exact match.
1012# objectId: The ID of the object involved in the audit action.
1013# The format of this ID
1014# varies by object type. Must be exact match.
1015# objectType: The type of the object involved in the audit
1016# action, such as `Watchlist`
1017# or `TemporalDataObject`. Must be exact match.
1018# success: Whether or not the action was successful.
1019# id: The unique ID of an audit log entry. Multiple values can be
1020# provided.
1021# offset: Offset into result set, for paging.
1022# limit: Limit on result size, for paging (page size). Audit
1023# queries are
1024# lightweight so the default of 100 is higher than the default offset
1025# used elsewhere in the API.
1026# orderBy: Order information. Default is order by
1027# `createdDateTime` descending.
1028auditLog(
1029toDateTime: DateTime,
1030fromDateTime: DateTime,
1031organizationId: ID,
1032userName: String,
1033clientIpAddress: String,
1034clientUserAgent: String,
1035eventType: String,
1036objectId: ID,
1037objectType: String,
1038success: Boolean,
1039id: [ID!],
1040offset: Int,
1041limit: Int,
1042orderBy: [AuditLogOrderBy!]
1043): AuditLogEntryList!
1044
1045# Get the media share by media shareId
1046mediaShare(id: ID!): MediaShare!
1047
1048# Retrieve a shared collection
1049#
1050# Arguments
1051# shareId: share token
1052sharedCollection(shareId: ID!): SharedCollection
1053
1054# Retrieve shared collection history records
1055#
1056# Arguments
1057# ids: Provide an ID to retrieve a single history record
1058# folderId: Provide a folder ID to filter by collection
1059# shareId: Provide a share ID to filter by share ID
1060# offset: Specify maximum number of results to retrieve in this
1061# result. Page size.
1062# limit: Specify maximum number of results to retrieve in this
1063# result.
1064sharedCollectionHistory(
1065ids: [ID!],
1066folderId: ID,
1067shareId: String,
1068offset: Int,
1069limit: Int
1070): SharedCollectionHistoryList!
1071
1072# Get list process templates by id or current organizationId
1073processTemplates(id: ID, offset: Int, limit: Int): ProcessTemplateList!
1074
1075# Get process templates by id
1076processTemplate(id: ID!): ProcessTemplate!
1077
1078# Get creative by id with current organizationId
1079creative(id: ID!): Creative!
1080
1081# Retrieve list of engine classes
1082#
1083# Arguments
1084# id: Provide an ID to retrieve a single specific engine class.
1085# name: Provide a name, or part of one, to search by class name
1086# offset: Specify maximum number of results to retrieve in this
1087# result. Page size.
1088# limit: Specify maximum number of results to retrieve in this
1089# result.
1090engineClasses(id: ID, name: String, offset: Int, limit: Int): EngineClassList
1091
1092# Retrieve a specific engine class
1093#
1094# Arguments
1095# id: Supply the ID of the engine class to retrieve
1096engineClass(id: ID!): EngineClass
1097
1098# Returns all custom dashboards created by user
1099#
1100# Arguments
1101# offset: Provide an offset to skip to a certain element in the
1102# result, for paging.
1103# limit: Specify maximum number of results to retrieve in this
1104# result. Page size.
1105# hostAppId: Include only dashboards created by specific
1106# host_app_id
1107customDashboards(offset: Int, limit: Int, hostAppId: ID): CustomDashboardList
1108
1109# Returns custom dashboard by id
1110customDashboard(id: ID!): CustomDashboard
1111
1112# Gets engine usage for an organization based on their billing type.
1113getUsageByTaskType: UsageByTaskType!
1114
1115# Retrives the specific Dataset
1116#
1117# Arguments
1118# id: Supply the ID of the Dataset to retrieve
1119dataset(id: ID!): Dataset
1120
1121# Retrieve list of Datasets
1122#
1123# Arguments
1124# offset: Provide an offset to skip to a certain element in the
1125# result, for paging.
1126# limit: Specify maximum number of results to retrieve in this
1127# result. Page size.
1128# filter: Filters for Dataset attributes
1129datasets(offset: Int, limit: Int, filter: DatasetFilter): DatasetList
1130
1131# Arguments
1132# datasetId: Supply the ID of the Dataset to retrieve
1133# offset: Provide an offset to skip to a certain element in the
1134# result, for paging.
1135# limit: Specify maximum number of results to retrieve in this
1136# result. Page size.
1137# filter: Query to filter SDO. Supports operations such as and,
1138# or, eq, gt, lt, etc.
1139# TODO link to syntax documentation
1140# orderBy: Order by
1141datasetDataQuery(
1142datasetId: ID!,
1143offset: Int,
1144limit: Int,
1145filter: JSONData,
1146orderBy: [StructuredDataOrderBy!]
1147): DatasetEntryList!
1148
1149# Retrive list of Engine Replacement
1150#
1151# Arguments
1152# organizationId: Only superadmin can get engine replacement of
1153# other orgs
1154# engineId: Filter by the source engineId
1155# offset: Provide an offset to skip to a certain element in the
1156# result, for paging.
1157# limit: Specify maximum number of results to retrieve in this
1158# result. Page size.
1159taskReplacementEngines(
1160organizationId: ID,
1161engineId: ID,
1162offset: Int,
1163limit: Int
1164): TaskReplacementEngineList
1165
1166# Retrive Notification Mailboxes by list of mailboxIds
1167notificationMailboxes(ids: [ID!]): [NotificationMailbox!]
1168
1169# Retrive Notification Templates
1170#
1171# Arguments
1172# ids: Get by array of ids
1173# eventName: Get by eventName
1174# eventType: Get by eventType
1175# application: Get by application
1176# mailboxId: Get by mailboxId
1177# ownerOrganizationId: Only super-admin or orgless token can get
1178# templates by ownerOrganizationId
1179# offset: Provide an offset to skip to a certain element in the
1180# result, for paging.
1181# limit: Specify maximum number of results to retrieve in this
1182# result. Page size.
1183notificationTemplates(
1184ids: [ID],
1185eventName: String,
1186eventType: String,
1187application: String,
1188mailboxId: ID,
1189ownerOrganizationId: ID,
1190offset: Int,
1191limit: Int
1192): NotificationTemplateList
1193
1194# Retrieve Notification Actions
1195#
1196# Arguments
1197# ids: Get by array of ids
1198# eventName: Get by eventName
1199# eventType: Get by eventType
1200# application: Get by application
1201# mailboxId: Get by mailboxId
1202# ownerOrganizationId: Only super-admin or orgless token can get
1203# templates by ownerOrganizationId
1204# offset: Provide an offset to skip to a certain element in the
1205# result, for paging.
1206# limit: Specify maximum number of results to retrieve in this
1207# result. Page size.
1208notificationActions(
1209ids: [ID],
1210eventName: String,
1211eventType: String,
1212application: String,
1213mailboxId: ID,
1214ownerOrganizationId: ID,
1215offset: Int,
1216limit: Int
1217): NotificationActionList
1218
1219# Retrieve Application user setting definitions
1220#
1221# Arguments
1222# application: Specify the applicationId
1223# key: Specify the key of user setting (optional)
1224# organizationGuid: Specify the organizationGuid (require for
1225# internal token)
1226# This can be specified by superadmin to get user setting definitions of other
1227# organization
1228getUserSettingDefinitions(
1229application: ID!,
1230key: String,
1231organizationGuid: ID
1232): [ApplicationSetting]
1233
1234# Retrive User setting
1235#
1236# Arguments
1237# userId: Filter by userId (optional).
1238# If it's not specified, default is current user
1239# application: Filter by applicationId
1240# keys: Filter by keys
1241getUserSettings(userId: ID, application: ID, keys: [String]): [UserSetting]
1242
1243staticAppConfig: StaticAppConfig!
1244
1245# Get OpenID Provider by id
1246openIdProvider(id: ID!): OpenIdProvider!
1247
1248# Get OpenID Provides
1249openIdProviders(ids: [ID], isGlobal: Boolean, offset: Int, limit: Int): OpenIdProviderList
1250
1251}

link Required by

This element is not required by anyone