OBJECT

Watchlist

link GraphQL Schema definition

1type Watchlist {
2
3# The primary ID
4id: ID!
5
6# A human-readable name for the watchlist
7name: String!
8
9# The organization that owns the watchlist
10organization: Organization!
11
12# ID of the organization that owns the watchlist
13organizationId: ID!
14
15# IDs of the schedules associated with the watchlist
16scheduleIds: [ID!]
17
18# Date and time at which the watchlist takes effect
19startDateTime: DateTime
20
21# Date and time at which the watchlist is no longer in effect
22stopDateTime: DateTime
23
24# Date and time the watchlist was created
25createdDateTime: DateTime
26
27# Date and time the watchlist was last modified
28modifiedDateTime: DateTime
29
30# Cognitives searches associated with the watchlist
31cognitiveSearches: [CognitiveSearch!]
32
33# Ids of the source types associated directly with the watchlist
34sourceTypeIds: [ID!]
35
36# IDs of the sources associated directly with the watchlist
37sourceIds: [ID!]
38
39# Folders that the watchlist is filed in.
40# At present, a watchlist can only be filed in a single folder.
41folders: [Folder!]
42
43# Structured metadata associated with the watchlist.
44# Elements of the metadata are validated against specific schemas.
45details: JSONData
46
47subscriptions: [Subscription!]!
48
49searchIndex: SearchIndex!
50
51query: JSONData
52
53# Get mentions generated for this watchlist
54mentions(offset: Int, limit: Int): MentionList
55
56# ID of the advertiser directly with the watchlist
57advertiserId: ID
58
59# ID of the brand directly with the watchlist
60brandId: ID
61
62# advertiser associated with the watchlist
63advertiser: JSONData
64
65# brand associated with the watchlist
66brand: JSONData
67
68# creative associated with the watchlist
69creative: Creative
70
71# The reference to the watchlist in a folder
72treeObjectId: ID @deprecated( reason: "obsolete" )
73
74# Indicates whether or not the watchlist should be disabled.
75# The Veritone platform can administratively disable watchlists
76# if the search scope as measured in number of mentions
77# exceeds organization limits. The owner can then modify the
78# watchlist parameters to reduce the scope and re-enable the watchlist.
79isDisabled: Boolean
80
81# Indicates whether the watchlist is currently creating mentions from exising
82# media
83isUpdating: Boolean
84
85# Is enable the expiration notification
86enableExpirationNotification: Boolean
87
88watchlistType: String
89
90}