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
1 type Query { 2 3 # Retrieve a list of temporal data objects. 4 # Example: 5 # Request: 6 # query { 7 # 8 # temporalDataObjects( 9 # 10 # organizationId: "35521"){ 11 # 12 # records{name} 13 # 14 # offset 15 # 16 # limit 17 # 18 # count 19 # 20 # } 21 # } 22 # Response: 23 # { 24 # 25 # "data": { 26 # 27 # "temporalDataObjects": { 28 # 29 # "records": [ 30 # 31 # { 32 # 33 # "name": "example" 34 # 35 # }, 36 # 37 # { 38 # 39 # "name": "example" 40 # 41 # }, 42 # 43 # ], 44 # 45 # "offset": 0, 46 # 47 # "limit": 30, 48 # 49 # "count": 8 50 # 51 # } 52 # 53 # } 54 # } 55 # 56 # Arguments 57 # organizationId: Organization ID to get TDOs for. Defaults to 58 # the user's own organization. 59 # You can only retrieves content for your own organizations or organizations 60 # that have shared data with yours. 61 # applicationId: Application ID (an authorization construct that 62 # maps directly to organization ID) 63 # to get TDOs for. Defaults to the user's own organization. 64 # id: Provide a list of IDs to retrieve the specific TDOs. 65 # offset: Provide an offset to skip to a certain element in the 66 # result, for paging. 67 # limit: Specify maximum number of results to retrieve in this 68 # result. Page size. 69 # sourceId: Optionally, specify a source ID. TDOs ingested from 70 # this source will 71 # be returned. 72 # programId: Optionally, specify a program ID. TDOs belong to 73 # this program will 74 # be returned. 75 # scheduledJobId: Optionally, specify a scheduled job ID. TDOs 76 # ingested under this 77 # scheduled job will be returned. 78 # sampleMedia: Whether to retrieve only tdos with the specified 79 # sampleMedia value 80 # includePublic: Whether to retrieve public data that is not part 81 # of the user's organization. 82 # The default is false. Pass true to include public data in the result set. 83 # dateTimeFilter: Provide optional filters against any date/time 84 # field to filter 85 # objects within a given time window. 86 # Matching objects must meet all of the given conditions. 87 # mentionId: Retrieve TDOs associated with the given mention 88 ( 89 ID, : 90 ID, : 91 ID, : 92 ID], : [ 93 Int, : 94 Int, : 95 ID, : 96 ID, : 97 ID, : 98 Boolean, : 99 Boolean, : 100 TemporalDataObjectOrderBy, : 101 OrderDirection, : 102 TemporalDataObjectDateTimeFilter!], : [ 103 ID : 104 ): TDOList 105 106 # Retrieve a single temporal data object 107 # Example: 108 # Request: 109 # query { 110 # 111 # temporalDataObject( 112 # 113 # id: 1570654874) { 114 # 115 # id 116 # 117 # name 118 # 119 # } 120 # } 121 # Response: 122 # { 123 # 124 # "data": { 125 # 126 # "temporalDataObject": { 127 # 128 # "id": "1570654874", 129 # 130 # "name": "example" 131 # 132 # } 133 # 134 # } 135 # } 136 # 137 # Arguments 138 # id: the TDO ID 139 ID!): TemporalDataObject ( : 140 141 # Retrieve a single Asset 142 # Example: 143 # Request: 144 # query { 145 # 146 # asset( 147 # 148 # id: "1570654874_4hJtNKSUXD") { 149 # 150 # id 151 # 152 # name 153 # 154 # description 155 # 156 # } 157 # } 158 # Response: 159 # { 160 # 161 # "data": { 162 # 163 # "asset": { 164 # 165 # "id": "1570654874_4hJtNKSUXD", 166 # 167 # "name": "example", 168 # 169 # "description": "example" 170 # 171 # } 172 # 173 # } 174 # } 175 # 176 # Arguments 177 # id: The asset ID 178 ID!): Asset ( : 179 180 # Retrieve multiple assets 181 # Example: 182 # Request: 183 # query { 184 # 185 # assets( 186 # 187 # ids:["1570654874_4hJtNKSUXD"], 188 # 189 # contentTypes:[], 190 # 191 # assetTypes:["text"], 192 # 193 # sourceEngineIds:[], 194 # 195 # createdDateFilter:null, 196 # 197 # scrollId: null){ 198 # 199 # assets{ 200 # 201 # records{id} 202 # 203 # count 204 # 205 # } 206 # 207 # scrollId 208 # 209 # } 210 # } 211 # Response: 212 # { 213 # 214 # "data": { 215 # 216 # "assets": { 217 # 218 # "assets": { 219 # 220 # "records": [], 221 # 222 # "count": 0 223 # 224 # }, 225 # 226 # "scrollId": "" 227 # 228 # } 229 # 230 # } 231 # } 232 # 233 # Arguments 234 # ids: List of asset ids 235 # contentTypes: Filter assets with content type included in the 236 # list 237 # See https://www.iana.org/assignments/media-types/media-types.xhtml 238 # assetTypes: Filter assets with assetType included in the list 239 # See https://docs.veritone.com/#/apis/tutorials/asset-types for list of values. 240 # sourceEngineIds: Filter by source engine. 241 # Not all assets have associated engineId, ex. media assets 242 # createdDateFilter: Filter by created date 243 # Note createdDateFilter.filter is required, but currently ignored 244 # offset: Offset to skip to a certain element in the result, for 245 # paging. 246 # limit: Maximum number of results to retrieve in this result. 247 # Page size. 248 # scrollId: Use this field when sequentially iterating over the 249 # assets list 250 # This is required for when offset + limit exceeds 10000. 251 # The value of this field is set from the response of the first/previous 252 # assets query 253 ( 254 ID!], : [ 255 String!], : [ 256 String!], : [ 257 String!], : [ 258 TemporalDataObjectDateTimeFilter, : 259 Int, : 260 Int, : 261 String : 262 ): AssetScrollList 263 264 # Retrieve a single Widget 265 # Example: 266 # Request: 267 # query { 268 # 269 # widget( 270 # 271 # id: "KOIFUT_rT_Oy3Ev9zfKT6A") { 272 # 273 # collection{ 274 # 275 # id 276 # 277 # } 278 # 279 # } 280 # } 281 # Response: 282 # { 283 # 284 # "data": { 285 # 286 # "widget": { 287 # 288 # "collection": { 289 # 290 # "id": "243625" 291 # 292 # } 293 # 294 # } 295 # 296 # } 297 # } 298 # 299 # Arguments 300 # id: The widget ID 301 ID!): Widget ( : 302 303 # Retrieve clone job entries 304 # Example: 305 # Request: 306 # query { 307 # 308 # cloneRequests { 309 # 310 # records{ 311 # 312 # id 313 # 314 # } 315 # 316 # } 317 # } 318 # 319 # Response: 320 # 321 # { 322 # 323 # "data": { 324 # 325 # "cloneRequests": { 326 # 327 # "records": [] 328 # 329 # } 330 # 331 # } 332 # } 333 # 334 # Arguments 335 # id: Provide an ID to retrieve a single specific clone request. 336 # applicationId: Application ID to get clone requests for. 337 # Defaults to the user's own application. 338 ID, : ID, : Int, : Int): CloneRequestList ( : 339 340 # Retrieve most recent builds 341 # Example: 342 # Request: 343 # query { 344 # 345 # recentBuilds(limit:2) { 346 # 347 # records{ 348 # 349 # id 350 # 351 # name 352 # 353 # } 354 # 355 # } 356 # } 357 # Response: 358 # { 359 # 360 # "data": { 361 # 362 # "recentBuilds": { 363 # 364 # "records": [ 365 # 366 # { 367 # 368 # "id": "44193f81-57b4-47dd-9fe0-be95000776d9", 369 # 370 # "name": "example Version 5" 371 # 372 # }, 373 # 374 # { 375 # 376 # "id": "bae12129-2724-40c3-abd2-6bb4021f21ae", 377 # 378 # "name": "example Version 4" 379 # 380 # } 381 # 382 # ] 383 # 384 # } 385 # 386 # } 387 # } 388 # 389 # Arguments 390 # buildStatus: Engine build status: 391 # offset: Specify maximum number of results to retrieve in this 392 # result. Page size. 393 # limit: Specify maximum number of results to retrieve in this 394 # result. 395 # orderBy: Set order information on the query. Multiple fields 396 # are supported. 397 # Default order by modifiedDateTime desc 398 ( 399 BuildStatus!], : [ 400 Int, : 401 Int, : 402 EngineBuildOrderBy!] : [ 403 ): BuildList 404 405 # Retrieve engine overview 406 # Example: 407 # Request: 408 # query { 409 # 410 # engineOverview { 411 # 412 # ready 413 # 414 # } 415 # } 416 # 417 # Response: 418 # 419 # { 420 # 421 # "data": { 422 # 423 # "engineOverview": { 424 # 425 # "ready": 7 426 # 427 # } 428 # 429 # } 430 # } 431 EngineOverview : 432 433 # Retrieve engines 434 # Example: 435 # Request: 436 # query { 437 # 438 # engines(limit:2) { 439 # 440 # records{ 441 # 442 # id 443 # 444 # state 445 # 446 # } 447 # 448 # } 449 # } 450 # Response: 451 # { 452 # 453 # "data": { 454 # 455 # "engines": { 456 # 457 # "records": [ 458 # 459 # { 460 # 461 # "id": "2", 462 # 463 # "state": "pending" 464 # 465 # }, 466 # 467 # { 468 # 469 # "id": "1", 470 # 471 # "state": "pending" 472 # 473 # } 474 # 475 # ] 476 # 477 # } 478 # 479 # } 480 # } 481 # 482 # Arguments 483 # id: Provide an ID to retrieve a single specific engine. 484 # categoryId: Provide a category ID to filter by engine category. 485 # category: provide a category name or ID to filter by engine 486 # category 487 # state: Provide a list of states to filter by engine state. 488 # owned: If true, return only engines owned by the user's 489 # organization. 490 # libraryRequired: If true, return only engines that require a 491 # library. 492 # createsTDO: If true, return only engines that create their own 493 # TDO. 494 # If false, return only engines that do not create a TDO. 495 # If not set, return either. 496 # name: Provide a name, or part of a name, to search by engine 497 # name 498 # offset: Specify maximum number of results to retrieve in this 499 # result. Page size. 500 # limit: Specify maximum number of results to retrieve in this 501 # result. 502 # filter: Filters for engine attributes 503 # orderBy: Provide a list of EngineSortField to sort by. 504 # edgeVersion: Edge version to filter 505 ( 506 ID, : 507 ID!], : [ 508 String, : 509 String, : 510 EngineState], : [ 511 Boolean, : 512 Boolean, : 513 Boolean, : 514 String, : 515 Int, : 516 Int, : 517 EngineFilter, : 518 EngineSortField], : [ 519 Int : 520 ): EngineList 521 522 # Retrieve a single engine by ID 523 # Example: 524 # Request: 525 # query { 526 # 527 # engine(id:1) { 528 # 529 # name 530 # 531 # state 532 # 533 # } 534 # } 535 # Response: 536 # { 537 # 538 # "data": { 539 # 540 # "engine": { 541 # 542 # "name": "example", 543 # 544 # "state": "pending" 545 # 546 # } 547 # 548 # } 549 # } 550 # 551 # Arguments 552 # id: Provide the engine ID 553 ID!): Engine ( : 554 555 # Retrieve an engine build 556 # Example: 557 # Request: 558 # query { 559 # 560 # engineBuild(id: "2a1a1b58-6983-4002-b9ed-7b7f325f621a"){ 561 # 562 # name 563 # 564 # engineId 565 # 566 # } 567 # } 568 # 569 # Response: 570 # { 571 # 572 # "data": { 573 # 574 # "engineBuild": { 575 # 576 # "name": "example Version 1", 577 # 578 # "engineId": "1" 579 # 580 # } 581 # 582 # } 583 # } 584 # 585 # Arguments 586 # id: Provide the build ID 587 ID!): Build ( : 588 589 # Retrieve engine categories 590 # Example: 591 # Request: 592 # query { 593 # 594 # engineCategories(limit:2) { 595 # 596 # records { 597 # 598 # id 599 # 600 # type { 601 # 602 # name 603 # 604 # } 605 # 606 # name 607 # 608 # } 609 # 610 # } 611 # } 612 # Response: 613 # { 614 # 615 # "data": { 616 # 617 # "engineCategories": { 618 # 619 # "records": [ 620 # 621 # { 622 # 623 # "id": "581dbb32-ea5b-4458-bd15-8094942345e3", 624 # 625 # "type": { 626 # 627 # "name": "Cognition" 628 # 629 # }, 630 # 631 # "name": "Transcode" 632 # 633 # }, 634 # 635 # { 636 # 637 # "id": "67cd4dd0-2f75-445d-a6f0-2f297d6cd182", 638 # 639 # "type": { 640 # 641 # "name": "Cognition" 642 # 643 # }, 644 # 645 # "name": "Transcription" 646 # 647 # } 648 # 649 # ] 650 # 651 # } 652 # 653 # } 654 # } 655 # 656 # Arguments 657 # id: Provide an ID to retrieve a single specific engine 658 # category. 659 # ids: Provide multiple IDs to retrieve engine categories 660 # name: Provide a name, or part of one, to search by category 661 # name 662 # type: Return all categories of an engine type 663 # offset: Specify maximum number of results to retrieve in this 664 # result. Page size. 665 # limit: Specify maximum number of results to retrieve in this 666 # result. 667 ( 668 ID, : 669 ID!], : [ 670 String, : 671 String, : 672 Int, : 673 Int : 674 ): EngineCategoryList 675 676 # Retrieve a specific engine category\ 677 # Example: 678 # Request: 679 # query { 680 # 681 # engineCategory(id: "581dbb32-ea5b-4458-bd15-8094942345e3") { 682 # 683 # name 684 # 685 # type{ 686 # 687 # name 688 # 689 # } 690 # 691 # } 692 # } 693 # Response: 694 # { 695 # 696 # "data": { 697 # 698 # "engineCategory": { 699 # 700 # "name": "Transcode", 701 # 702 # "type": { 703 # 704 # "name": "Cognition" 705 # 706 # } 707 # 708 # } 709 # 710 # } 711 # } 712 # 713 # Arguments 714 # id: Supply the ID of the engine category to retrieve 715 ID!): EngineCategory ( : 716 717 # Retrieve jobs 718 # Example: 719 # Request: 720 # query { 721 # 722 # jobs(limit:2) { 723 # 724 # records{ 725 # 726 # id 727 # 728 # name 729 # 730 # } 731 # 732 # } 733 # } 734 # Response: 735 # { 736 # 737 # "data": { 738 # 739 # "jobs": { 740 # 741 # "records": [] 742 # 743 # } 744 # 745 # } 746 # } 747 # 748 # Arguments 749 # id: Provide an ID to retrieve a single specific job. 750 # status: Provide a list of status strings to filter by status 751 # offset: Provide an offset to skip to a certain element in the 752 # result, for paging. 753 # limit: Specify the maximum number of results to included in 754 # this response, or page size. 755 # applicationId: Provide an application ID to filter jobs for a 756 # given application. 757 # Defaults to the user's own application. 758 # targetId: Provide a target ID to get the set of jobs running 759 # against a particular TDO. 760 # clusterId: Provide a cluster ID to get the jobs running on a 761 # specific cluster 762 # scheduledJobIds: Provide a list of scheduled job IDs to get 763 # jobs associated with the scheduled jobs 764 # hasScheduledJobId: Return only jobs that are (true) or are not 765 # (false) associated with a scheduled job 766 # orderBy: Provide sort information. The default is to sort by 767 # createdDateTime descending. 768 # dateTimeFilter: Filter by date/time field 769 # applicationIds: Provide list of application IDs to filter jobs. 770 # Defaults to the user's own application. 771 # engineIds: Provide a list of engine IDs to filter for jobs 772 # that contain tasks for the specified engines. 773 # engineCategoryIds: Provide a list of engine category IDs to 774 # filter for jobs 775 # that contain tasks for engines in the specific categories. 776 ( 777 Boolean, : 778 ID, : 779 JobStatusFilter!], : [ 780 String, : 781 Int, : 782 Int, : 783 ID, : 784 ID, : 785 ID, : 786 ID!], : [ 787 Boolean, : 788 JobSortField!], : [ 789 JobDateTimeFilter!], : [ 790 ID], : [ 791 ID!], : [ 792 ID!] : [ 793 ): JobList 794 795 # Retrieve a single job by ID 796 # 797 # Arguments 798 # id: the job ID. 799 ID!): Job ( : 800 801 # Retrieve a single task by ID 802 # 803 # Arguments 804 # id: Provide the task ID. 805 ID!): Task ( : 806 807 # Retrieve entity identifier types 808 # Example: 809 # Request: 810 # query { 811 # 812 # entityIdentifierTypes(limit:2) { 813 # 814 # records{ 815 # 816 # id 817 # 818 # label 819 # 820 # } 821 # 822 # } 823 # } 824 # Response: 825 # { 826 # 827 # "data": { 828 # 829 # "entityIdentifierTypes": { 830 # 831 # "records": [ 832 # 833 # { 834 # 835 # "id": "face", 836 # 837 # "label": "Face" 838 # 839 # }, 840 # 841 # { 842 # 843 # "id": "audio-recording", 844 # 845 # "label": "audio file" 846 # 847 # } 848 # 849 # ] 850 # 851 # } 852 # 853 # } 854 # } 855 # 856 # Arguments 857 # id: Provide an ID to retrieve a single specific entity 858 # identifier type. 859 # offset: Provide an offset to skip to a certain element in the 860 # result, for paging. 861 # limit: Specify maximum number of results to retrieve in this 862 # result. Page size. 863 ID, : Int, : Int): EntityIdentifierTypeList ( : 864 865 # Retrieve an entity identifier type 866 # Example: 867 # Request: 868 # query { 869 # 870 # entityIdentifierType(id:"face") { 871 # 872 # label 873 # 874 # entityIdentifierItems { 875 # 876 # libraryTypeId 877 # 878 # } 879 # 880 # } 881 # } 882 # Response: 883 # { 884 # 885 # "data": { 886 # 887 # "entityIdentifierType": { 888 # 889 # "label": "Face", 890 # 891 # "entityIdentifierItems": [ 892 # 893 # { 894 # 895 # "libraryTypeId": "people" 896 # 897 # }, 898 # 899 # { 900 # 901 # "libraryTypeId": "suspect" 902 # 903 # }, 904 # 905 # { 906 # 907 # "libraryTypeId": "people-known-offender" 908 # 909 # }, 910 # 911 # { 912 # 913 # "libraryTypeId": "people-of-interest" 914 # 915 # } 916 # 917 # ] 918 # 919 # } 920 # 921 # } 922 # } 923 # 924 # Arguments 925 # id: Provide the entity identifier type ID 926 ID!): EntityIdentifierType ( : 927 928 # Retrieve all library types 929 # Example: 930 # Request: 931 # query { 932 # 933 # libraryTypes(limit:2) { 934 # 935 # records{ 936 # 937 # id 938 # 939 # entityTypeName 940 # 941 # } 942 # 943 # } 944 # } 945 # Response: 946 # { 947 # 948 # "data": { 949 # 950 # "libraryTypes": { 951 # 952 # "records": [ 953 # 954 # { 955 # 956 # "id": "people-known-offender", 957 # 958 # "entityTypeName": "known offender" 959 # 960 # }, 961 # 962 # { 963 # 964 # "id": "dataset", 965 # 966 # "entityTypeName": "dataset" 967 # 968 # } 969 # 970 # ] 971 # 972 # } 973 # 974 # } 975 # } 976 # 977 # Arguments 978 # id: Provide an ID to retrieve a single specific library type. 979 # offset: Provide an offset to skip to a certain element in the 980 # result, for paging. 981 # limit: Specify maximum number of results to retrieve in this 982 # result. Page size. 983 ID, : Int, : Int): LibraryTypeList ( : 984 985 # Retrieve a single library type 986 # Example: 987 # Request: 988 # query { 989 # 990 # libraryType(id: "people-known-offender") { 991 # 992 # entityTypeName 993 # 994 # label 995 # 996 # } 997 # } 998 # Response: 999 # { 1000 # 1001 # "data": { 1002 # 1003 # "libraryType": { 1004 # 1005 # "entityTypeName": "known offender", 1006 # 1007 # "label": "IDentify - Known Offender" 1008 # 1009 # } 1010 # 1011 # } 1012 # } 1013 # 1014 # Arguments 1015 # id: Provide an ID to retrieve a single specific library type. 1016 ID): LibraryType ( : 1017 1018 # Retrieve libraries and entities 1019 # Example: 1020 # Request: 1021 # query { 1022 # 1023 # libraries(limit:2) { 1024 # 1025 # records { 1026 # 1027 # id 1028 # 1029 # name 1030 # 1031 # libraryTypeId 1032 # 1033 # } 1034 # 1035 # } 1036 # } 1037 # Response: 1038 # { 1039 # 1040 # "data": { 1041 # 1042 # "libraries": { 1043 # 1044 # "records": [ 1045 # 1046 # { 1047 # 1048 # "id": "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599", 1049 # 1050 # "name": "example", 1051 # 1052 # "libraryTypeId": "123" 1053 # 1054 # } 1055 # 1056 # ] 1057 # 1058 # } 1059 # 1060 # } 1061 # } 1062 # 1063 # Arguments 1064 # id: Provide an ID to retrieve a single specific library. 1065 # name: Provide a name string to search by name. 1066 # type: Provide the name or ID of a library to search for 1067 # libraries 1068 # that contain that type. 1069 # entityIdentifierTypeIds: Provide the id of an entity identifier 1070 # type to search for libraries that correlate 1071 # to that type. 1072 # includeOwnedOnly: Specify true if only libraries owned by the 1073 # user's organization 1074 # should be returned. Otherwise, shared libraries will be included. 1075 # offset: Provide an offset to skip to a certain element in the 1076 # result, for paging. 1077 # limit: Specify maximum number of results to retrieve in this 1078 # result. Page size. 1079 # orderBy: Specify a field to order by 1080 # orderDirection: Specify the direction to order by 1081 ( 1082 ID, : 1083 String, : 1084 String, : 1085 String!], : [ 1086 Boolean, : 1087 Int, : 1088 Int, : 1089 LibraryOrderBy, : 1090 OrderDirection : 1091 ): LibraryList 1092 1093 # Retrieve a specific library 1094 # Example: 1095 # Request: 1096 # query { 1097 # 1098 # library(id: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599") { 1099 # 1100 # name 1101 # 1102 # organizationId 1103 # 1104 # } 1105 # } 1106 # Response: 1107 # { 1108 # 1109 # "data": { 1110 # 1111 # "library": { 1112 # 1113 # "name": "example", 1114 # 1115 # "organizationId": "35521" 1116 # 1117 # } 1118 # 1119 # } 1120 # } 1121 # 1122 # Arguments 1123 # id: Provide a library ID. 1124 ID!): Library ( : 1125 1126 # Retrieve a specific library engine model 1127 # Example: 1128 # Request: 1129 # query { 1130 # 1131 # libraryEngineModel(id: "87714ca6-8dbd-4da0-9dc0-d9233927b00d") { 1132 # 1133 # trainStatus 1134 # 1135 # engineId 1136 # 1137 # } 1138 # } 1139 # Response: 1140 # { 1141 # 1142 # "data": { 1143 # 1144 # "libraryEngineModel": { 1145 # 1146 # "trainStatus": "pending", 1147 # 1148 # "engineId": "1" 1149 # 1150 # } 1151 # 1152 # } 1153 # } 1154 # 1155 # Arguments 1156 # id: Provide the library engine model ID 1157 ID!): LibraryEngineModel ( : 1158 1159 # Retrieve a specific entity 1160 # Example: 1161 # Request: 1162 # query { 1163 # 1164 # entity(id: "85b700fa-f327-4fea-b94b-ed83054170db") { 1165 # 1166 # name 1167 # 1168 # libraryId 1169 # 1170 # isPublished 1171 # 1172 # } 1173 # } 1174 # Response: 1175 # { 1176 # 1177 # "data": { 1178 # 1179 # "entity": { 1180 # 1181 # "name": "example", 1182 # 1183 # "libraryId": "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599", 1184 # 1185 # "isPublished": false 1186 # 1187 # } 1188 # 1189 # } 1190 # } 1191 # 1192 # Arguments 1193 # id: Provide an entity ID. 1194 ID!): Entity ( : 1195 1196 # Retrieve a list of entities across libraries 1197 # Example: 1198 # Request: 1199 # query { 1200 # 1201 # entities(libraryIds: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599") { 1202 # 1203 # records { 1204 # 1205 # id 1206 # 1207 # name 1208 # 1209 # isPublished 1210 # 1211 # } 1212 # 1213 # } 1214 # } 1215 # Response: 1216 # { 1217 # 1218 # "data": { 1219 # 1220 # "entities": { 1221 # 1222 # "records": [ 1223 # 1224 # { 1225 # 1226 # "id": "85b700fa-f327-4fea-b94b-ed83054170db", 1227 # 1228 # "name": "example", 1229 # 1230 # "isPublished": false 1231 # 1232 # } 1233 # 1234 # ] 1235 # 1236 # } 1237 # 1238 # } 1239 # } 1240 # 1241 # Arguments 1242 # ids: Provide a list of entity IDs to retrieve those entities 1243 # libraryIds: Provide a list of library IDs to retrieve entities 1244 # across 1245 # multiple libraries. 1246 ( 1247 ID!], : [ 1248 ID!], : [ 1249 Boolean, : 1250 ID, : 1251 String, : 1252 Int, : 1253 Int, : 1254 LibraryEntityOrderBy, : 1255 OrderDirection : 1256 ): EntityList 1257 1258 # Retrieve library configuration 1259 # Example: 1260 # Request: 1261 # query { 1262 # 1263 # libraryConfiguration(id:"7396e71b-db5a-4c4c-bf6f-4fc66a5a07f7") { 1264 # 1265 # confidence{ 1266 # 1267 # min 1268 # 1269 # max 1270 # 1271 # } 1272 # 1273 # } 1274 # } 1275 # Response: 1276 # { 1277 # 1278 # "data": { 1279 # 1280 # "libraryConfiguration": { 1281 # 1282 # "confidence": { 1283 # 1284 # "min": 0, 1285 # 1286 # "max": 100 1287 # 1288 # } 1289 # 1290 # } 1291 # 1292 # } 1293 # } 1294 # 1295 # Arguments 1296 # id: Provide configuration id 1297 ID!): LibraryConfiguration ( : 1298 1299 # Retrieve applications. These are custom applications integrated into 1300 # the Veritone platform using the VDA framework. 1301 # Example: 1302 # Request: 1303 # query { 1304 # 1305 # applications(limit:2) { 1306 # 1307 # records { 1308 # 1309 # id 1310 # 1311 # name 1312 # 1313 # } 1314 # 1315 # } 1316 # } 1317 # Response: 1318 # { 1319 # 1320 # "data": { 1321 # 1322 # "applications": { 1323 # 1324 # "records": [ 1325 # 1326 # { 1327 # 1328 # "id": "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a", 1329 # 1330 # "name": "appexamplebill" 1331 # 1332 # }, 1333 # 1334 # { 1335 # 1336 # "id": "5908703b-51b4-4291-9787-b54bada73b0a", 1337 # 1338 # "name": "appexample2" 1339 # 1340 # } 1341 # 1342 # ] 1343 # 1344 # } 1345 # 1346 # } 1347 # } 1348 # 1349 # Arguments 1350 # id: Provide an ID to retrieve a single specific application. 1351 # status: Provide a status, such as "draft" or "active" 1352 # owned: If true, return only applications owned by the user's 1353 # organization. 1354 # orgId: For super admin user only, if specified, the query 1355 # returns applications for this orgId. 1356 # isPublic: Filter applications that are public 1357 # excludeViewOnly: Include package grantType==VIEW 1358 # filter: Filters for application attributes 1359 # offset: Provide an offset to skip to a certain element in the 1360 # result, for paging. 1361 # limit: Specify maximum number of results to retrieve in this 1362 # result. Page size. 1363 # orderBy: Provide a list of ApplicationSortField to sort by. 1364 # accessScope: Specify one or more access scopes to filter by 1365 # accessible applications 1366 ( 1367 ID, : 1368 ApplicationStatus, : 1369 Boolean, : 1370 ID, : 1371 Boolean, : 1372 Boolean, : 1373 ApplicationFilter, : 1374 Int, : 1375 Int, : 1376 ApplicationSortField], : [ 1377 AccessScope!] : [ 1378 ): ApplicationList 1379 1380 # Retrieve organizations 1381 # Example: 1382 # Request: 1383 # query { 1384 # 1385 # organizations(limit:2) { 1386 # 1387 # records { 1388 # 1389 # id 1390 # 1391 # name 1392 # 1393 # } 1394 # 1395 # } 1396 # } 1397 # Response: 1398 # { 1399 # 1400 # "data": { 1401 # 1402 # "organizations": { 1403 # 1404 # "records": [ 1405 # 1406 # { 1407 # 1408 # "id": "35521", 1409 # 1410 # "name": "WTS API Docs Org" 1411 # 1412 # } 1413 # 1414 # ] 1415 # 1416 # } 1417 # 1418 # } 1419 # } 1420 # 1421 # Arguments 1422 # id: Provide an ID to retrieve a single specific organization. 1423 # offset: Provide an offset to skip to a certain element in the 1424 # result, for paging. 1425 # limit: Specify maximum number of results to retrieve in this 1426 # result. Page size. 1427 # kvpProperty: Provide a property from the organization kvp to 1428 # filter the organization list. 1429 # kvpValue: Provide value to for the kvpFeature filter. 1430 # If not present the filter becomes kvpProperty existence filter 1431 # name: Optionally, supply a string for string match 1432 # nameMatch: Supply the type of string match to apply. 1433 ( 1434 ID, : 1435 Int, : 1436 Int, : 1437 String, : 1438 String, : 1439 String, : 1440 StringMatch, : 1441 Boolean : 1442 ): OrganizationList 1443 1444 # Retrieve a single organization 1445 # Example: 1446 # Request: 1447 # query { 1448 # 1449 # organization(id: "35521") { 1450 # 1451 # status 1452 # 1453 # } 1454 # } 1455 # Response: 1456 # { 1457 # 1458 # "data": { 1459 # 1460 # "organization": { 1461 # 1462 # "status": "active" 1463 # 1464 # } 1465 # 1466 # } 1467 # } 1468 # 1469 # Arguments 1470 # id: The organization ID 1471 # TODO take application ID as well as org ID 1472 ID!): Organization ( : 1473 1474 # Retrieve basic organization info about the organizations to which the user 1475 # belongs 1476 # Example: 1477 # Request: 1478 # query { 1479 # 1480 # myOrganizations { 1481 # 1482 # records { 1483 # 1484 # id 1485 # 1486 # name 1487 # 1488 # } 1489 # 1490 # } 1491 # } 1492 # Response: 1493 # { 1494 # 1495 # "data": { 1496 # 1497 # "myOrganizations": { 1498 # 1499 # "records": [ 1500 # 1501 # { 1502 # 1503 # "id": "35521", 1504 # 1505 # "name": "WTS API Docs Org" 1506 # 1507 # } 1508 # 1509 # ] 1510 # 1511 # } 1512 # 1513 # } 1514 # } 1515 # 1516 # Arguments 1517 # offset: Provide an offset to skip to a certain element in the 1518 # result, for paging. 1519 # limit: Specify maximum number of results to retrieve in this 1520 # result. Page size. 1521 # status: Filter by organization status 1522 ( 1523 Int, : 1524 Int, : 1525 OrganizationStatus, : 1526 String : 1527 ): OrganizationInfoList 1528 1529 # Retrieve the login configuration for an organization 1530 # Example: 1531 # Request: 1532 # query { 1533 # 1534 # loginConfiguration(slug: "my-organization") { 1535 # 1536 # organizationInfo { 1537 # 1538 # id 1539 # 1540 # name 1541 # 1542 # } 1543 # 1544 # } 1545 # } 1546 # Response: 1547 # { 1548 # 1549 # "data": { 1550 # 1551 # "loginConfiguration": { 1552 # 1553 # "organizationInfo": { 1554 # 1555 # "id": "12345", 1556 # 1557 # "name": "My Organization" 1558 # 1559 # } 1560 # 1561 # } 1562 # 1563 # } 1564 # } 1565 # 1566 # Arguments 1567 # slug: The login slug associated with the login configuration 1568 # for an organization 1569 String!): LoginConfiguration ( : 1570 1571 # Retrieve permissions 1572 # Example: 1573 # Request: 1574 # query { 1575 # 1576 # permissions(limit:5) { 1577 # 1578 # records { 1579 # 1580 # id 1581 # 1582 # name 1583 # 1584 # } 1585 # 1586 # } 1587 # } 1588 # 1589 # Response: 1590 # { 1591 # 1592 # "data": { 1593 # 1594 # "permissions": { 1595 # 1596 # "records": [ 1597 # 1598 # { 1599 # 1600 # "id": "2", 1601 # 1602 # "name": "admin.access" 1603 # 1604 # }, 1605 # 1606 # { 1607 # 1608 # "id": "9", 1609 # 1610 # "name": "admin.group.create" 1611 # 1612 # }, 1613 # 1614 # { 1615 # 1616 # "id": "12", 1617 # 1618 # "name": "admin.group.delete" 1619 # 1620 # }, 1621 # 1622 # { 1623 # 1624 # "id": "10", 1625 # 1626 # "name": "admin.group.read" 1627 # 1628 # }, 1629 # 1630 # { 1631 # 1632 # "id": "11", 1633 # 1634 # "name": "admin.group.update" 1635 # 1636 # } 1637 # 1638 # ] 1639 # 1640 # } 1641 # 1642 # } 1643 # } 1644 # 1645 # Arguments 1646 # id: Provide an ID to retrieve a single specific permission. 1647 # offset: Provide an offset to skip to a certain element in the 1648 # result, for paging. 1649 # limit: Specify maximum number of results to retrieve in this 1650 # result. Page size. 1651 ID, : String, : Int, : Int): PermissionList ( : 1652 1653 # Retrieve users 1654 # Example: 1655 # Request: 1656 # query { 1657 # 1658 # users( 1659 # 1660 # organizationIds:"35521", 1661 # 1662 # limit: 2) { 1663 # 1664 # records { 1665 # 1666 # id 1667 # 1668 # name 1669 # 1670 # } 1671 # 1672 # } 1673 # } 1674 # Response: 1675 # { 1676 # 1677 # "data": { 1678 # 1679 # "users": { 1680 # 1681 # "records": [ 1682 # 1683 # { 1684 # 1685 # "id": "267de7e1-efb2-444a-a524-210328b78503", 1686 # 1687 # "name": "example" 1688 # 1689 # }, 1690 # 1691 # { 1692 # 1693 # "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066", 1694 # 1695 # "name": "example1" 1696 # 1697 # } 1698 # 1699 # ] 1700 # 1701 # } 1702 # 1703 # } 1704 # } 1705 # 1706 # Arguments 1707 # id: Provide an ID to retrieve a single specific user. 1708 # A user ID is a string in UUID format. 1709 # ids: Provide IDs to retrieve multiple users by ID. 1710 # name: Provide a name, or part of one, to search by name. 1711 # organizationIds: Provide a list of organization IDs to filter 1712 # your search by organization. 1713 # offset: Provide an offset to skip to a certain element in the 1714 # result, for paging. 1715 # limit: Specify maximum number of results to retrieve in this 1716 # result. Page size. 1717 # includeAllOrgUsers: Include all organization users. 1718 # dateTimeFilter: Filter by date/time field 1719 # status: Filter by account status 1720 # roleIds: Filter by application roles 1721 ( 1722 ID, : 1723 ID], : [ 1724 String, : 1725 ID], : [ 1726 Int, : 1727 Int, : 1728 Boolean, : 1729 UsersDateTimeFilter!], : [ 1730 UserStatus, : 1731 ID] : [ 1732 ): UserList 1733 1734 # Retrieve an individual user 1735 # Example: 1736 # Request: 1737 # query { 1738 # 1739 # user(id: "267de7e1-efb2-444a-a524-210328b78503") { 1740 # 1741 # name 1742 # 1743 # status 1744 # 1745 # } 1746 # } 1747 # Response: 1748 # { 1749 # 1750 # "data": { 1751 # 1752 # "user": { 1753 # 1754 # "name": "example", 1755 # 1756 # "status": "deleted" 1757 # 1758 # } 1759 # 1760 # } 1761 # } 1762 # 1763 # Arguments 1764 # id: The user ID. 1765 # A user ID is a string in UUID format. 1766 ID!, : [ID]): User ( : 1767 1768 # Retrieve user's organization API tokens 1769 # Example: 1770 # Request: 1771 # query { 1772 # 1773 # tokens { 1774 # 1775 # id 1776 # 1777 # applicationId 1778 # 1779 # } 1780 # } 1781 # Response: 1782 # { 1783 # 1784 # "data": { 1785 # 1786 # "tokens": [] 1787 # 1788 # } 1789 # } 1790 Token] : [ 1791 1792 # Retrieve information for the current logged-in user 1793 # Example: 1794 # Request: 1795 # query { 1796 # 1797 # me { 1798 # 1799 # id 1800 # 1801 # organizationId 1802 # 1803 # } 1804 # } 1805 # Response: 1806 # { 1807 # 1808 # "data": { 1809 # 1810 # "me": { 1811 # 1812 # "id": "59cb4e74-7c31-4267-b91e-d4600bc08008", 1813 # 1814 # "organizationId": "35521" 1815 # 1816 # } 1817 # 1818 # } 1819 # } 1820 User : 1821 1822 # Retrieve groups 1823 # Example: 1824 # Request: 1825 # query { 1826 # 1827 # groups { 1828 # 1829 # records { 1830 # 1831 # id 1832 # 1833 # name 1834 # 1835 # } 1836 # 1837 # } 1838 # } 1839 # Response: 1840 # { 1841 # 1842 # "data": { 1843 # 1844 # "groups": { 1845 # 1846 # "records": [ 1847 # 1848 # { 1849 # 1850 # "id": "8db639c1-c926-4f83-90de-d86c2ae5973d", 1851 # 1852 # "name": "WTS API Docs Org" 1853 # 1854 # } 1855 # 1856 # ] 1857 # 1858 # } 1859 # 1860 # } 1861 # } 1862 # 1863 # Arguments 1864 # id: Provide an ID to retrieve a specific group by ID 1865 # ids: Provide IDs to retrieve multiple groups by ID 1866 # name: Provide a name, or part of one, to search for groups by 1867 # name 1868 # organizationIds: " 1869 # Provide a list of organization IDs to retrieve groups defined 1870 # within certain organizations. 1871 # offset: Provide an offset to skip to a certain element in the 1872 # result, for paging. 1873 # limit: Specify maximum number of results to retrieve in this 1874 # result. Page size. 1875 ID, : [ID], : String, : [ID], : Int, : Int): GroupList ( : 1876 1877 # Retrieve a single mention 1878 # 1879 # Arguments 1880 # mentionId: The mention ID 1881 # limit: Comments pagination - limit 1882 # offset: Comments pagination - limit 1883 # userId: The user who owns the mention. 1884 ID!, : Int, : Int, : String): Mention ( : 1885 1886 # Retrieve a shared mention 1887 # 1888 # Arguments 1889 # shareId: share token 1890 ID!): SharedMention ( : 1891 1892 # Search for mentions across an index. 1893 # This query requires a user token. 1894 # Known Issues: 1895 # - Offset can not go past 10,000. To get around this, the best practice is to 1896 # keep updating the start time of the query based on the last mention you have 1897 # processed. 1898 # Example: 1899 # Request: 1900 # query{ 1901 # 1902 # searchMentions(search:{ 1903 # 1904 # offset: 0 1905 # 1906 # limit: 1 1907 # 1908 # index: ["mine"] 1909 # 1910 # query:{ 1911 # 1912 # operator: "and" 1913 # 1914 # conditions: [{ 1915 # 1916 # operator: "term" 1917 # 1918 # field: "trackingUnitName" 1919 # 1920 # value: "Dallas Cowboys Super Bowl" 1921 # 1922 # }, 1923 # 1924 # { 1925 # 1926 # operator: "term" 1927 # 1928 # field: "mentionStatusId" 1929 # 1930 # value: "1" 1931 # 1932 # }] 1933 # 1934 # } 1935 # 1936 # }) { 1937 # 1938 # jsondata 1939 # 1940 # } 1941 # } 1942 # Response: 1943 # { 1944 # 1945 # "data": { 1946 # 1947 # "searchMentions": { 1948 # 1949 # "jsondata": { 1950 # 1951 # "results": [ 1952 # 1953 # { 1954 # 1955 # "id": 47569938, 1956 # 1957 # "programFormatName": "Information and News", 1958 # 1959 # "mentionDate": "2017-01-31T07:59:18.000Z", 1960 # 1961 # "mediaStartTime": "2017-01-31T07:45:01.000Z", 1962 # 1963 # "mediaId": 20017455, 1964 # 1965 # "metadata": { 1966 # 1967 # "filename": "AM-RADIO", 1968 # 1969 # "veritone-file": { 1970 # 1971 # "size": 0, 1972 # 1973 # "filename": "AM-RADIO", 1974 # 1975 # "mimetype": "audio/mpeg" 1976 # 1977 # }, 1978 # 1979 # "veritone-media-source": { 1980 # 1981 # "mediaSourceId": "14326", 1982 # 1983 # "mediaSourceTypeId": "1" 1984 # 1985 # }, 1986 # 1987 # "veritone-program": { 1988 # 1989 # "programId": "3828", 1990 # 1991 # "programName": "AM-RADIO Morning Talk", 1992 # 1993 # "programImage": 1994 # "https://s3.amazonaws.com/veritone-ugc/cb5e59d4-a986-4e2b-b525-482319df3350%2FbrdProgram%2F2uGsLVKsQeiKN3UuHufC_941478_10151455644772706_951533539_n.jpg", 1995 # 1996 # "programLiveImage": 1997 # "https://s3.amazonaws.com/prod-veritone-ugc/cb5e59d4-a986-4e2b-b525-482319df3350%2FbrdProgram%2FwwEn3Ya9RgmMQwUEGoD1_LUkKlgZQS36ncUbY8Iz7_2520to%2520live2.JPG" 1998 # 1999 # } 2000 # 2001 # }, 2002 # 2003 # "fileLocation": 2004 # "https://inspirent.s3.amazonaws.com/recordings/9605ea97-87df-428e-6740-720df8b8691c_original.mp3?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAI7L6G7PCOOOLA7MQ%2F20171215%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20171215T205111Z&X-Amz-Expires=604800&X-Amz-Signature=00f62a6e2367c109320c98b9aea190cd28d82ac347eeeca030f42810b7ab75e3&X-Amz-SignedHeaders=host", 2005 # 2006 # "fileType": "audio/mpeg", 2007 # 2008 # "snippets": [ 2009 # 2010 # { 2011 # 2012 # "startTime": 857.62, 2013 # 2014 # "endTime": 887.33, 2015 # 2016 # "text": "eighty first women's Australian Open final Monica Seles beat Steffi 2017 # Graf four six six three six two in one thousand nine hundred twenty eight the 2018 # Dallas Cowboys beat the Buffalo Bills thirty to thirteen in Atlanta running back 2019 # Emmitt Smith wins the M.V.P. and fourth consecutive Super Bowl game loss to the 2020 # Cowboys twenty sixteen at the one hundred fourth women's Australian Open final 2021 # six three six six four that time capsule your", 2022 # 2023 # "hits": [ 2024 # 2025 # { 2026 # 2027 # "startTime": 865.7, 2028 # 2029 # "endTime": 865.929, 2030 # 2031 # "queryTerm": "Dallas" 2032 # 2033 # }, 2034 # 2035 # { 2036 # 2037 # "startTime": 865.93, 2038 # 2039 # "endTime": 866.07, 2040 # 2041 # "queryTerm": "Cowboys" 2042 # 2043 # }, 2044 # 2045 # { 2046 # 2047 # "startTime": 872.74, 2048 # 2049 # "endTime": 873.31, 2050 # 2051 # "queryTerm": "Super" 2052 # 2053 # }, 2054 # 2055 # { 2056 # 2057 # "startTime": 873.31, 2058 # 2059 # "endTime": 873.43, 2060 # 2061 # "queryTerm": "Bowl" 2062 # 2063 # } 2064 # 2065 # ] 2066 # 2067 # } 2068 # 2069 # ], 2070 # 2071 # "userSnippets": null, 2072 # 2073 # "advertiserId": 0, 2074 # 2075 # "advertiserName": "", 2076 # 2077 # "brandId": 0, 2078 # 2079 # "brandImage": "", 2080 # 2081 # "brandName": "", 2082 # 2083 # "campaignId": 0, 2084 # 2085 # "campaignName": "", 2086 # 2087 # "organizationId": 7295, 2088 # 2089 # "organizationName": "Demo Organization", 2090 # 2091 # "trackingUnitId": 10032, 2092 # 2093 # "trackingUnitName": "Dallas Cowboys Super Bowl", 2094 # 2095 # "mentionStatusId": 1, 2096 # 2097 # "mediaSourceTypeId": 1, 2098 # 2099 # "mediaSourceTypeName": "Audio", 2100 # 2101 # "mediaSourceId": 14326, 2102 # 2103 # "mediaSourceName": "AM-RADIO Morning Talk", 2104 # 2105 # "isNational": true, 2106 # 2107 # "spotTypeId": null, 2108 # 2109 # "spotTypeName": null, 2110 # 2111 # "programId": 3828, 2112 # 2113 # "programName": "AM-RADIO", 2114 # 2115 # "programImage": 2116 # "https://s3.amazonaws.com/prod-veritone-ugc/cb5e59d4-a986-4e2b-b525-482319df3350%2FbrdProgram%2F2uGsLVKsQeiKN3UuHufC_941478_10151455644772706_951533539_n.jpg", 2117 # 2118 # "programLiveImage": 2119 # "https://s3.amazonaws.com/veritone-ugc/cb5e52b4-a986-4e2b-b525-482319df3350%2FbrdProgram%2FwwEn3Ya9RgmMQwUEGoD1_LUkKlgZQS36ncUbY8Iz7_2520to%2520live2.JPG", 2120 # 2121 # "impressions": 1894, 2122 # 2123 # "audience": [ 2124 # 2125 # { 2126 # 2127 # "gender": "men", 2128 # 2129 # "age_group": "35-44", 2130 # 2131 # "audience": 11, 2132 # 2133 # "isTargetMatch": true 2134 # 2135 # }, 2136 # 2137 # { 2138 # 2139 # "gender": "men", 2140 # 2141 # "age_group": "45-49", 2142 # 2143 # "audience": 121, 2144 # 2145 # "isTargetMatch": true 2146 # 2147 # }, 2148 # 2149 # { 2150 # 2151 # "gender": "men", 2152 # 2153 # "age_group": "50-54", 2154 # 2155 # "audience": 474, 2156 # 2157 # "isTargetMatch": true 2158 # 2159 # }, 2160 # 2161 # { 2162 # 2163 # "gender": "men", 2164 # 2165 # "age_group": "65+", 2166 # 2167 # "audience": 95, 2168 # 2169 # "isTargetMatch": true 2170 # 2171 # }, 2172 # 2173 # { 2174 # 2175 # "gender": "women", 2176 # 2177 # "age_group": "50-54", 2178 # 2179 # "audience": 19, 2180 # 2181 # "isTargetMatch": false 2182 # 2183 # }, 2184 # 2185 # { 2186 # 2187 # "gender": "women", 2188 # 2189 # "age_group": "65+", 2190 # 2191 # "audience": 693, 2192 # 2193 # "isTargetMatch": false 2194 # 2195 # }, 2196 # 2197 # { 2198 # 2199 # "gender": "men", 2200 # 2201 # "age_group": "55-64", 2202 # 2203 # "audience": 481, 2204 # 2205 # "isTargetMatch": true 2206 # 2207 # } 2208 # 2209 # ], 2210 # 2211 # "targetAudience": { 2212 # 2213 # "gender": 1, 2214 # 2215 # "genderName": "M", 2216 # 2217 # "ageGroup": [ 2218 # 2219 # 0, 2220 # 2221 # 5 2222 # 2223 # ], 2224 # 2225 # "ageGroupMin": 18, 2226 # 2227 # "ageGroupMax": 0, 2228 # 2229 # "impressions": 1182 2230 # 2231 # }, 2232 # 2233 # "audienceMarketCount": 3, 2234 # 2235 # "audienceAffiliateCount": 1, 2236 # 2237 # "rating": null, 2238 # 2239 # "ratings": null, 2240 # 2241 # "comments": null, 2242 # 2243 # "markets": [ 2244 # 2245 # { 2246 # 2247 # "marketId": 54, 2248 # 2249 # "marketName": "Des Moines-Ames, IA" 2250 # 2251 # } 2252 # 2253 # ], 2254 # 2255 # "marketId": null, 2256 # 2257 # "marketName": null, 2258 # 2259 # "hourOfDay": 7, 2260 # 2261 # "dayOfWeek": 2, 2262 # 2263 # "dayOfMonth": 31, 2264 # 2265 # "month": 1, 2266 # 2267 # "year": 2017, 2268 # 2269 # "isMatch": true, 2270 # 2271 # "mentionStatusName": "Pending Verification", 2272 # 2273 # "complianceStatusId": null, 2274 # 2275 # "cognitiveEngineResults": null, 2276 # 2277 # "hits": 4 2278 # 2279 # } 2280 # 2281 # ], 2282 # 2283 # "totalResults": 579, 2284 # 2285 # "limit": 1, 2286 # 2287 # "from": 0, 2288 # 2289 # "to": 0, 2290 # 2291 # "searchToken": "ae882400-e1d9-11e7-947b-339cddca931e", 2292 # 2293 # "timestamp": 1513371071 2294 # 2295 # } 2296 # 2297 # } 2298 # 2299 # } 2300 # } 2301 # 2302 # Arguments 2303 # search: JSON structure containing the search query. 2304 # See https://docs.veritone.com/#/apis/search-quickstart for full details on the 2305 # search query syntax 2306 JSONData!): SearchResult ( : 2307 2308 # Search for media across an index. 2309 # This query requires a user token. 2310 # Example: 2311 # Request: 2312 # query{ 2313 # 2314 # searchMedia(search:{ 2315 # 2316 # offset: 0 2317 # 2318 # limit: 1 2319 # 2320 # index: ["mine"] 2321 # 2322 # query:{ 2323 # 2324 # operator: "query_string" 2325 # 2326 # field: "transcript.transcript" 2327 # 2328 # value: "paris NOT \"las vegas\"" 2329 # 2330 # } 2331 # 2332 # }) { 2333 # 2334 # jsondata 2335 # 2336 # } 2337 # } 2338 # Response: 2339 # { 2340 # 2341 # "data": { 2342 # 2343 # "searchMedia": { 2344 # 2345 # "jsondata": { 2346 # 2347 # "results": [ 2348 # 2349 # { 2350 # 2351 # "recording": { 2352 # 2353 # "recordingId": "43033727", 2354 # 2355 # "fileLocation": 2356 # "https://inspirent.s3.amazonaws.com/assets/43033727/ea9d9845-775b-48cd-aada-16fa56894ba0.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAI7L6G7PCOOOLA7MQ%2F20171215%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20171215T181255Z&X-Amz-Expires=604800&X-Amz-Signature=2fd918d5ac20979bd27d365bfa455904cf1726307fddbd362a28a8bd9a0a81a8&X-Amz-SignedHeaders=host", 2357 # 2358 # "fileType": "video/mp4", 2359 # 2360 # "programId": "-1", 2361 # 2362 # "programName": "Weekly Talkshow", 2363 # 2364 # "programLiveImage": 2365 # "https://inspirent.s3.amazonaws.com/assets/43033727/fe693b30-18ae-47c7-984f-530eab61d7.jpeg", 2366 # 2367 # "mediaSourceId": "-1", 2368 # 2369 # "mediaSourceTypeId": "5", 2370 # 2371 # "sliceTime": 1512682022, 2372 # 2373 # "mediaStartTime": 1512681992, 2374 # 2375 # "aibDuration": 90, 2376 # 2377 # "isOwn": true, 2378 # 2379 # "hitStartTime": 1512682022, 2380 # 2381 # "hitEndTime": 1512682082 2382 # 2383 # }, 2384 # 2385 # "startDateTime": 1512682022, 2386 # 2387 # "stopDateTime": 1512682082, 2388 # 2389 # "hits": [ 2390 # 2391 # { 2392 # 2393 # "veritone-file": { 2394 # 2395 # "filename": "Veritone_v06.mp4", 2396 # 2397 # "mimetype": "video/mp4", 2398 # 2399 # "size": 162533502 2400 # 2401 # } 2402 # 2403 # } 2404 # 2405 # ] 2406 # 2407 # } 2408 # 2409 # ], 2410 # 2411 # "totalResults": 733275, 2412 # 2413 # "limit": 1, 2414 # 2415 # "from": 0, 2416 # 2417 # "to": 0, 2418 # 2419 # "searchToken": "930f0960-e1c3-11e7-9e94-eba5f6b5faf7", 2420 # 2421 # "timestamp": 1513361576 2422 # 2423 # } 2424 # 2425 # } 2426 # 2427 # } 2428 # } 2429 # 2430 # Arguments 2431 # search: JSON structure containing the search query. 2432 # See https://docs.veritone.com/#/apis/search-quickstart for full details on the 2433 # search query syntax 2434 JSONData!): SearchResult ( : 2435 2436 # Retrieve the root folders for an organization 2437 # Example: 2438 # Request: 2439 # query { 2440 # 2441 # rootFolders { 2442 # 2443 # id 2444 # 2445 # typeId 2446 # 2447 # } 2448 # } 2449 # Response: 2450 # { 2451 # 2452 # "data": { 2453 # 2454 # "rootFolders": [ 2455 # 2456 # { 2457 # 2458 # "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982", 2459 # 2460 # "typeId": 4 2461 # 2462 # }, 2463 # 2464 # { 2465 # 2466 # "id": "d3e27eb3-7d4a-47ab-af64-bf1529390f4e", 2467 # 2468 # "typeId": 4 2469 # 2470 # } 2471 # 2472 # ] 2473 # 2474 # } 2475 # } 2476 # 2477 # Arguments 2478 # type: The type of root folder to retrieve 2479 RootFolderType): [Folder] ( : 2480 2481 # Retrieve a single folder. Used to navigate the folder tree structure. 2482 # Example: 2483 # Request: 2484 # query { 2485 # 2486 # folder(id: "2ac28573-917a-4c4b-be91-a0ac64cbc982") { 2487 # 2488 # typeId 2489 # 2490 # id 2491 # 2492 # childFolders{ 2493 # 2494 # records{ 2495 # 2496 # id 2497 # 2498 # } 2499 # 2500 # } 2501 # 2502 # } 2503 # } 2504 # Response: 2505 # { 2506 # 2507 # "data": { 2508 # 2509 # "folder": { 2510 # 2511 # "typeId": 4, 2512 # 2513 # "id": "3104f61f-4bd1-4175-9fe6-27436d591c54", 2514 # 2515 # "childFolders": { 2516 # 2517 # "records": [ 2518 # 2519 # { 2520 # 2521 # "id": "9d639f1b-a0d4-47b0-8149-3568f048f320" 2522 # 2523 # }, 2524 # 2525 # { 2526 # 2527 # "id": "a347319d-72da-43a2-93fc-e677876aca80" 2528 # 2529 # } 2530 # 2531 # ] 2532 # 2533 # } 2534 # 2535 # } 2536 # 2537 # } 2538 # } 2539 # 2540 # Arguments 2541 # id: Provide an ID to retrieve a single specific user. 2542 ID!): Folder ( : 2543 2544 # Retrieve the current platform information. 2545 # Example: 2546 # Request: 2547 # query { 2548 # 2549 # platformInfo { 2550 # 2551 # properties 2552 # 2553 # aiWAREVersion { 2554 # 2555 # currentVersion { 2556 # 2557 # version 2558 # 2559 # } 2560 # 2561 # previousVersion { 2562 # 2563 # version 2564 # 2565 # } 2566 # 2567 # nextVersion { 2568 # 2569 # version 2570 # 2571 # } 2572 # 2573 # } 2574 # 2575 # aiWAREVersionHistory(offset: 0, limit: 30) { 2576 # 2577 # platformVersion { 2578 # 2579 # id 2580 # 2581 # version 2582 # 2583 # } 2584 # 2585 # id 2586 # 2587 # }, 2588 # 2589 # aiWAREVersionList (orderBy: version, orderDirection: desc) { 2590 # 2591 # count 2592 # 2593 # records { 2594 # 2595 # id 2596 # 2597 # version 2598 # 2599 # } 2600 # 2601 # } 2602 # 2603 # } 2604 # } 2605 # Response: 2606 # { 2607 # 2608 # "data": { 2609 # 2610 # "platformInfo": { 2611 # 2612 # "properties": { 2613 # 2614 # "Environment": "US West", 2615 # 2616 # "ClusterSize": "small" 2617 # 2618 # } 2619 # 2620 # "aiWAREVersion": { 2621 # 2622 # "currentVersion": { 2623 # 2624 # "version": "1.1.0" 2625 # 2626 # }, 2627 # 2628 # "previousVersion": { 2629 # 2630 # "version": "1.0.0" 2631 # 2632 # }, 2633 # 2634 # "nextVersion": { 2635 # 2636 # "version": "1.2.0" 2637 # 2638 # } 2639 # 2640 # }, 2641 # 2642 # "aiWAREVersionHistory": [ 2643 # 2644 # { 2645 # 2646 # platformVersion: 2647 # 2648 # { 2649 # 2650 # "id": "c7a91281-6a1e-46d4-9f2c-7f8b4a1fc493", 2651 # 2652 # "version": "1.3.0" 2653 # 2654 # }, 2655 # 2656 # "id": "30c9c2a2-ae6a-4be2-b80c-6893d8b56780" 2657 # 2658 # }, 2659 # 2660 # { 2661 # 2662 # platformVersion: 2663 # 2664 # { 2665 # 2666 # "id": "f785bc56-2d43-472e-8629-99f9b9a5c57e", 2667 # 2668 # "version": "1.3.0" 2669 # 2670 # }, 2671 # 2672 # "id": "7b8a2ab2-00de-4f1b-9fb1-99e7a9cd108f" 2673 # 2674 # }, 2675 # 2676 # { 2677 # 2678 # platformVersion: 2679 # 2680 # { 2681 # 2682 # "id": "3c4c0b46-1a61-45ab-9f3e-b8f7a14bfaa7", 2683 # 2684 # "version": "1.3.0" 2685 # 2686 # }, 2687 # 2688 # "id": "d3499a78-efc7-4a72-a12d-852f53231e33" 2689 # 2690 # } 2691 # 2692 # ], 2693 # 2694 # "aiWAREVersionList": { 2695 # 2696 # "count": 3, 2697 # 2698 # "records": [ 2699 # 2700 # { 2701 # 2702 # "id": "799150bb-8d67-4cd1-b204-d9346e012588", 2703 # 2704 # "version": "1.0.11" 2705 # 2706 # }, 2707 # 2708 # { 2709 # 2710 # "id": "2892e80d-e0bf-4ffc-be17-4bb173d6ad29", 2711 # 2712 # "version": "1.0.2" 2713 # 2714 # }, 2715 # 2716 # { 2717 # 2718 # "id": "095b9558-6fc1-4775-9696-082b9f098c47", 2719 # 2720 # "version": "1.0.1" 2721 # 2722 # }, 2723 # 2724 # ] 2725 # 2726 # } 2727 # 2728 # } 2729 # 2730 # } 2731 # } 2732 PlatformInfo! : 2733 2734 # Example: 2735 # Request: 2736 # query { 2737 # 2738 # auditEvents(limit: 2) { 2739 # 2740 # records { 2741 # 2742 # id 2743 # 2744 # application 2745 # 2746 # } 2747 # 2748 # } 2749 # } 2750 # Response: 2751 # { 2752 # 2753 # "data": { 2754 # 2755 # "auditEvents": { 2756 # 2757 # "records": [ 2758 # 2759 # { 2760 # 2761 # "id": "fdc7b3a3-ab23-4866-a330-c0ad910cd64f", 2762 # 2763 # "application": "" 2764 # 2765 # } 2766 # 2767 # ] 2768 # 2769 # } 2770 # 2771 # } 2772 # } 2773 # 2774 # Arguments 2775 # query: An elastic query for audit events 2776 # application: Filter logs by a specific application 2777 # terms: Term filters to filter documents by properties in the 2778 # payload 2779 ( 2780 JSONData, : 2781 OrderDirection, : 2782 String, : 2783 JSONData!], : [ 2784 Int, : 2785 Int : 2786 ): AuditEventList! 2787 2788 # Retrieve a folder overview 2789 # Example: 2790 # Request: 2791 # query { 2792 # 2793 # folderOverview(ids:"3104f61f-4bd1-4175-9fe6-27436d591c54") { 2794 # 2795 # childFoldersCount 2796 # 2797 # childNonFolderObjectsCount 2798 # 2799 # } 2800 # } 2801 # Response: 2802 # { 2803 # 2804 # "data": { 2805 # 2806 # "folderOverview": { 2807 # 2808 # "childFoldersCount": 3, 2809 # 2810 # "childNonFolderObjectsCount": 0 2811 # 2812 # } 2813 # 2814 # } 2815 # } 2816 # 2817 # Arguments 2818 # ids: Tree Object Ids 2819 ID!]!, : RootFolderType): FolderOverview ( : [ 2820 2821 # Example: 2822 # Request: 2823 # query { 2824 # 2825 # folderSummaryDetails(ids: "3104f61f-4bd1-4175-9fe6-27436d591c54") { 2826 # 2827 # id 2828 # 2829 # typeId 2830 # 2831 # } 2832 # } 2833 # Response: 2834 # { 2835 # 2836 # "data": { 2837 # 2838 # "folderSummaryDetails": [ 2839 # 2840 # { 2841 # 2842 # "id": "1580701928", 2843 # 2844 # "typeId": 5 2845 # 2846 # }, 2847 # 2848 # { 2849 # 2850 # "id": "1580388995", 2851 # 2852 # "typeId": 5 2853 # 2854 # }, 2855 # 2856 # { 2857 # 2858 # "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982", 2859 # 2860 # "typeId": 4 2861 # 2862 # }, 2863 # 2864 # { 2865 # 2866 # "id": "243625", 2867 # 2868 # "typeId": 3 2869 # 2870 # }, 2871 # 2872 # { 2873 # 2874 # "id": "242599", 2875 # 2876 # "typeId": 3 2877 # 2878 # }, 2879 # 2880 # { 2881 # 2882 # "id": "d551fbd6-7354-4b0e-abfb-654ab8583be2", 2883 # 2884 # "typeId": 1 2885 # 2886 # }, 2887 # 2888 # { 2889 # 2890 # "id": "a347319d-72da-43a2-93fc-e677876aca80", 2891 # 2892 # "typeId": 1 2893 # 2894 # }, 2895 # 2896 # { 2897 # 2898 # "id": "9d639f1b-a0d4-47b0-8149-3568f048f320", 2899 # 2900 # "typeId": 1 2901 # 2902 # } 2903 # 2904 # ] 2905 # 2906 # } 2907 # } 2908 # 2909 # Arguments 2910 # ids: Tree Object Ids 2911 ( 2912 ID!]!, : [ 2913 RootFolderType : 2914 ): [FolderSummaryDetail] 2915 2916 # Retrieve configs for a given application 2917 # Example: 2918 # Request: 2919 # query { 2920 # 2921 # applicationConfig(applicationId: "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a") { 2922 # 2923 # records: { 2924 # 2925 # configType 2926 # 2927 # configLevel 2928 # 2929 # } 2930 # 2931 # offset: 0 2932 # 2933 # limit: 1 2934 # 2935 # } 2936 # } 2937 # Response: 2938 # { 2939 # 2940 # "data": { 2941 # 2942 # "applicationConfig": { 2943 # 2944 # "records": { 2945 # 2946 # "configType": "String", 2947 # 2948 # "configLevel": "Organization" 2949 # 2950 # } 2951 # 2952 # } 2953 # 2954 # } 2955 # } 2956 # 2957 # Arguments 2958 # orgId: Optional. Organization ID. 2959 # 2960 # If not specified, this will be the user's organization 2961 # userId: Optional. If specified, returned the configs for this 2962 # user and organization combo 2963 # includeDefaults: If true, include defaults not specified 2964 # configKeyRegexp: If specified, filter the configKey 2965 # offset: Specify maximum number of results to retrieve in this 2966 # result. Page size. 2967 # limit: Specify maximum number of results to retrieve in this 2968 # result. 2969 ( 2970 ID!, : 2971 ID, : 2972 ID, : 2973 Boolean, : 2974 String, : 2975 Int, : 2976 Int : 2977 ): ApplicationConfigList! 2978 2979 # Retrieve config definitions for a given application 2980 # Example: 2981 # Request: 2982 # query { 2983 # 2984 # applicationConfigDefinition(applicationId: 2985 # "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a", configKey: 'dark mode') { 2986 # 2987 # records: { 2988 # 2989 # configType 2990 # 2991 # defaultValue 2992 # 2993 # } 2994 # 2995 # offset: 0 2996 # 2997 # limit: 1 2998 # 2999 # } 3000 # } 3001 # Response: 3002 # { 3003 # 3004 # "data": { 3005 # 3006 # "applicationConfigDefinition": { 3007 # 3008 # "records": [{ 3009 # 3010 # "configType": Boolean, 3011 # 3012 # "defaultValue": true, 3013 # 3014 # }] 3015 # 3016 # } 3017 # 3018 # } 3019 # } 3020 # 3021 # Arguments 3022 # configKey: If specified, grab definition for this config key 3023 # offset: Specify maximum number of results to retrieve in this 3024 # result. Page size. 3025 # limit: Specify maximum number of results to retrieve in this 3026 # result. 3027 ( 3028 ID!, : 3029 String, : 3030 Int, : 3031 Int : 3032 ): ApplicationConfigDefinitionList! 3033 3034 # Retrieve a single application 3035 # Example: 3036 # Request: 3037 # query { 3038 # 3039 # application(id: "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a") { 3040 # 3041 # name 3042 # 3043 # key 3044 # 3045 # } 3046 # } 3047 # Response: 3048 # { 3049 # 3050 # "data": { 3051 # 3052 # "application": { 3053 # 3054 # "name": "appexamplebill", 3055 # 3056 # "key": "appexamplebill" 3057 # 3058 # } 3059 # 3060 # } 3061 # } 3062 # 3063 # Arguments 3064 # id: The application ID 3065 # excludeViewOnly: Only retrieve package grantType=VIEW when 3066 # explicitly enter false 3067 ID!, : Boolean): Application ( : 3068 3069 # Retrieve headerbar information for an application 3070 # Example: 3071 # Request: 3072 # query { 3073 # 3074 # applicationHeaderbar(id: "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a") { 3075 # 3076 # name 3077 # 3078 # config { 3079 # 3080 # title 3081 # 3082 # } 3083 # 3084 # } 3085 # } 3086 # Response: 3087 # { 3088 # 3089 # "data": { 3090 # 3091 # "applicationHeaderbar": { 3092 # 3093 # "name": "APP_BAR", 3094 # 3095 # "config": { 3096 # 3097 # "title": "Library" 3098 # 3099 # } 3100 # 3101 # } 3102 # 3103 # } 3104 # } 3105 # 3106 # Arguments 3107 # appId: The application ID 3108 # orgId: Optional organization ID. Normally this value is 3109 # computed by the server 3110 # based on the authorization token used for the request. 3111 ID!, : ID): ApplicationHeaderbar ( : 3112 3113 # Retrieve a list of schemas for structured data ingestions\ 3114 # Example: 3115 # Request: 3116 # query { 3117 # 3118 # schemas(limit: 2) { 3119 # 3120 # records { 3121 # 3122 # id 3123 # 3124 # organizationId 3125 # 3126 # } 3127 # 3128 # } 3129 # } 3130 # Response: 3131 # { 3132 # 3133 # "data": { 3134 # 3135 # "schemas": { 3136 # 3137 # "records": [ 3138 # 3139 # { 3140 # 3141 # "id": "21a08123-45dc-497e-b329-360d9f3fcaac", 3142 # 3143 # "organizationId": "35521" 3144 # 3145 # }, 3146 # 3147 # { 3148 # 3149 # "id": "57aa1618-344d-4d35-9980-5fe1ec6c3112", 3150 # 3151 # "organizationId": "35521" 3152 # 3153 # } 3154 # 3155 # ] 3156 # 3157 # } 3158 # 3159 # } 3160 # } 3161 # 3162 # Arguments 3163 # id: Id of a schema to retrieve 3164 # ids: Ids of schemas to retrieve 3165 # dataRegistryId: Specify the id of the DataRegistry to get 3166 # schemas 3167 # status: Specify one or more statuses to filter by schema status 3168 # majorVersion: Specify a major version to filter schemas 3169 # name: Specify a data registry name to filter schemas 3170 # nameMatch: The strategy used to find data registry name 3171 # accessScope: Specify one or more access scopes to filter by 3172 # accessible schemas 3173 # limit: Limit 3174 # offset: Offset 3175 # orderBy: Specify one or more fields and direction to order 3176 # results 3177 ( 3178 ID, : 3179 ID!], : [ 3180 ID, : 3181 SchemaStatus!], : [ 3182 Int, : 3183 String, : 3184 StringMatch, : 3185 AccessScope!], : [ 3186 Int, : 3187 Int, : 3188 SchemaOrder] : [ 3189 ): SchemaList 3190 3191 # Retrieve a schema for structured data ingestions 3192 # Example: 3193 # Request: 3194 # query { 3195 # 3196 # schema(id: "21a08123-45dc-497e-b329-360d9f3fcaac") { 3197 # 3198 # definition 3199 # 3200 # status 3201 # 3202 # } 3203 # } 3204 # Response: 3205 # { 3206 # 3207 # "data": { 3208 # 3209 # "schema": { 3210 # 3211 # "definition": { 3212 # 3213 # "example": "example value" 3214 # 3215 # }, 3216 # 3217 # "status": "draft" 3218 # 3219 # } 3220 # 3221 # } 3222 # } 3223 # 3224 # Arguments 3225 # id: Supply the ID of the schema to retrieve 3226 ID!): Schema ( : 3227 3228 # Example: 3229 # Request: 3230 # query { 3231 # 3232 # schemaProperties(limit: 2) { 3233 # 3234 # records { 3235 # 3236 # type 3237 # 3238 # dataRegistryId 3239 # 3240 # } 3241 # 3242 # } 3243 # } 3244 # Response: 3245 # { 3246 # 3247 # "data": { 3248 # 3249 # "schemaProperties": { 3250 # 3251 # "records": [ 3252 # 3253 # { 3254 # 3255 # "type": "string", 3256 # 3257 # "dataRegistryId": "c3c9fa66-15b2-4bc4-b37f-c790e3ea0db6" 3258 # 3259 # }, 3260 # 3261 # { 3262 # 3263 # "type": "string", 3264 # 3265 # "dataRegistryId": "dbfa78af-f935-4ace-8a70-f70ca36ce49c" 3266 # 3267 # } 3268 # 3269 # ] 3270 # 3271 # } 3272 # 3273 # } 3274 # } 3275 # 3276 # Arguments 3277 # limit: Limit 3278 # offset: Offset 3279 ( 3280 DataRegistryVersion!], : [ 3281 String, : 3282 Int, : 3283 Int : 3284 ): SchemaPropertyList 3285 3286 # Retrieve a structured data object 3287 # Example: 3288 # Request: 3289 # query { 3290 # 3291 # structuredData( 3292 # 3293 # id: "bbc0d388-b7ed-4073-9760-cb7701130eaf", 3294 # 3295 # schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9") { 3296 # 3297 # data 3298 # 3299 # } 3300 # } 3301 # Response: 3302 # { 3303 # 3304 # "data": { 3305 # 3306 # "structuredData": { 3307 # 3308 # "data": { 3309 # 3310 # "example": "example" 3311 # 3312 # } 3313 # 3314 # } 3315 # 3316 # } 3317 # } 3318 # 3319 # Arguments 3320 # id: Supply the ID of the structured data object to retrieve. 3321 # This will override filters. 3322 # schemaId: Schema Id for the structured data object to retrieve 3323 ID!, : ID!): StructuredData ( : 3324 3325 # Retrieve a structured data object 3326 # Example: 3327 # Request: 3328 # query { 3329 # 3330 # structuredDataObject( 3331 # 3332 # id: "bbc0d388-b7ed-4073-9760-cb7701130eaf", 3333 # 3334 # schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9") { 3335 # 3336 # data 3337 # 3338 # } 3339 # } 3340 # Response: 3341 # { 3342 # 3343 # "data": { 3344 # 3345 # "structuredDataObject": { 3346 # 3347 # "data": { 3348 # 3349 # "example": "example" 3350 # 3351 # } 3352 # 3353 # } 3354 # 3355 # } 3356 # } 3357 # 3358 # Arguments 3359 # id: Supply the ID of the structured data object to retrieve. 3360 # This will override filters. 3361 # schemaId: Schema Id for the structured data object to retrieve 3362 ID!, : ID!): StructuredData ( : 3363 3364 # Retrieve a paginated list of structured data object 3365 # Example: 3366 # Request: 3367 # query { 3368 # 3369 # structuredDataObjects(schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9") { 3370 # 3371 # records { 3372 # 3373 # id 3374 # 3375 # data 3376 # 3377 # } 3378 # 3379 # } 3380 # } 3381 # Response: 3382 # { 3383 # 3384 # "data": { 3385 # 3386 # "structuredDataObjects": { 3387 # 3388 # "records": [ 3389 # 3390 # { 3391 # 3392 # "id": "bbc0d388-b7ed-4073-9760-cb7701130eaf", 3393 # 3394 # "data": { 3395 # 3396 # "example": "example" 3397 # 3398 # } 3399 # 3400 # }, 3401 # 3402 # { 3403 # 3404 # "id": "f914eafe-ed9b-46b1-a48d-effd5575764a", 3405 # 3406 # "data": { 3407 # 3408 # "example": "example" 3409 # 3410 # } 3411 # 3412 # } 3413 # 3414 # ] 3415 # 3416 # } 3417 # 3418 # } 3419 # } 3420 # 3421 # Arguments 3422 # id: Supply the ID of the structured data object to retrieve. 3423 # This will override filters. 3424 # ids: List of Ids of the structured data objects to retrieve. 3425 # This will override filters. 3426 # schemaId: Schema Id for the structured data object to retrieve 3427 # filter: Query to filter SDO. Supports operations such as and, 3428 # or, eq, gt, lt, etc. 3429 # TODO link to syntax documentation 3430 ( 3431 ID, : 3432 ID!], : [ 3433 ID!, : 3434 StructuredDataOrderBy!], : [ 3435 Int, : 3436 Int, : 3437 Boolean, : 3438 JSONData : 3439 ): StructuredDataList 3440 3441 # Returns information about the GraphQL server, useful 3442 # for diagnostics. This data is primarily used by Veritone 3443 # development, and some fields may be restricted to Veritone administrators. 3444 GraphQLServiceInfo : 3445 3446 # Returns a signed writable S3 URL. A client can then 3447 # upload to this URL with an HTTP PUT without providing 3448 # any additional authorization (_note_: it must be a PUT. 3449 # A POST will fail.) 3450 # Example: 3451 # Request: 3452 # query { 3453 # 3454 # getSignedWritableUrl(type: "preview") { 3455 # 3456 # bucket 3457 # 3458 # key 3459 # 3460 # url 3461 # 3462 # } 3463 # } 3464 # Response: 3465 # { 3466 # 3467 # "data": { 3468 # 3469 # "getSignedWritableUrl": { 3470 # 3471 # "bucket": "prod-api.veritone.com", 3472 # 3473 # "key": 3474 # "35521/preview/2021/5/5/_/19-50-374_ed2c10a7-6f96-4d7c-a498-7bedeb383c7e", 3475 # 3476 # "url": 3477 # "https://s3.amazonaws.com/prod-api.veritone.com/35521/preview/2021/5/5/_/19-50-374_ed2c10a7-6f96-4d7c-a498-7bedeb383c7e?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQMR5VATUHU3MEGOA%2F20210618%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20210618T194850Z&X-Amz-Expires=86400&X-Amz-Signature=44857350a7f0b7311d4b911b557f4171a6ffe126c76e3d26f6e5cd532f645e53&X-Amz-SignedHeaders=host" 3478 # 3479 # } 3480 # 3481 # } 3482 # } 3483 # 3484 # Arguments 3485 # key: Optional key of the object to generate a writable 3486 # URL for. If not provided, a new, unique key will 3487 # be generated. If a key is provided and resembles a file name 3488 # (with extension delimited by .), a UUID will be inserted 3489 # into the file name, leaving the extension intact. 3490 # If a key is provided and does not resemble 3491 # a file name, a UUID will be appended. 3492 # type: Optional type of resource, such as `asset`, `thumbnail`, 3493 # `discovery-analytics` or `preview` 3494 # path: Optional extended path information. If the uploaded 3495 # content will be contained 3496 # within a container such as a `TemporalDataObject` (for `asset`) or `Library` 3497 # (for `entityIdentifier`), the ID of the object should be provided here. 3498 # expiresInSeconds: Optional expiresInSeconds custom expiration 3499 # to signedUrlExpires 3500 # Max expiresInSeconds up to 604800 3501 # organizationId: Optional organization ID. Normally this value 3502 # is computed by the server 3503 # based on the authorization token used for the request. 3504 # Is is used only by Veritone platform components. 3505 ( 3506 String, : 3507 String, : 3508 String, : 3509 Int, : 3510 ID : 3511 ): WritableUrlInfo 3512 3513 # Return writable storage URLs in bulk. 3514 # A maximum of 1000 can be created in one call. 3515 # See `getSignedWritableUrl` for details on usage of the 3516 # response contents. 3517 # Example: 3518 # Request: 3519 # query { 3520 # 3521 # getSignedWritableUrls(number: 2) { 3522 # 3523 # bucket 3524 # 3525 # key 3526 # 3527 # url 3528 # 3529 # } 3530 # } 3531 # Response: 3532 # { 3533 # 3534 # "data": { 3535 # 3536 # "getSignedWritableUrls": [ 3537 # 3538 # { 3539 # 3540 # "bucket": "prod-api.veritone.com", 3541 # 3542 # "key": "35521/other/2021/5/5/_/19-19-384_723ca284-cee6-4883-af16-edcbfed86433", 3543 # 3544 # "url": 3545 # "https://s3.amazonaws.com/prod-api.veritone.com/35521/other/2021/5/5/_/19-19-384_723ca284-cee6-4883-af16-edcbfed86433?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQMR5VATUHU3MEGOA%2F20210618%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20210618T194919Z&X-Amz-Expires=86400&X-Amz-Signature=57c8d9046297e6d6839d19e7d22552618e9ff89dd4855ca7f7aceb26e89d3de4&X-Amz-SignedHeaders=host" 3546 # 3547 # }, 3548 # 3549 # { 3550 # 3551 # "bucket": "prod-api.veritone.com", 3552 # 3553 # "key": "35521/other/2021/5/6/_/19-19-384_76af4aeb-5d9b-4bc4-b1d0-251e3f57b651", 3554 # 3555 # "url": 3556 # "https://s3.amazonaws.com/prod-api.veritone.com/35521/other/2021/5/6/_/19-19-384_76af4aeb-5d9b-4bc4-b1d0-251e3f57b651?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQMR5VATUHU3MEGOA%2F20210618%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20210618T194919Z&X-Amz-Expires=86400&X-Amz-Signature=9e139df517ca85fa0b969f0d3ff55b890b8a5e199c4fa7b3a26ea2f12a65bfec&X-Amz-SignedHeaders=host" 3557 # 3558 # } 3559 # 3560 # ] 3561 # 3562 # } 3563 # } 3564 # 3565 # Arguments 3566 # number: Number of signed URLs to return 3567 # type: Optional type of resource, such as `asset`, `thumbnail`, 3568 # or `preview` 3569 # path: Optional extended path information. If the uploaded 3570 # content will be contained 3571 # within a container such as a `TemporalDataObject` (for `asset`) or `Library` 3572 # (for `entityIdentifier`), the ID of the object should be provided here. 3573 # organizationId: Optional organization ID. Normally this value 3574 # is computed by the server 3575 # based on the authorization token used for the request. 3576 # Is is used only by Veritone platform components. 3577 ( 3578 Int!, : 3579 String, : 3580 String, : 3581 ID : 3582 ): [WritableUrlInfo!]! 3583 3584 # Retrieve the rights of the current user 3585 # Example: 3586 # Request: 3587 # query { 3588 # 3589 # myRights { 3590 # 3591 # resources 3592 # 3593 # operations 3594 # 3595 # } 3596 # } 3597 # Response: 3598 # { 3599 # 3600 # "data": { 3601 # 3602 # "myRights": { 3603 # 3604 # "resources": {}, 3605 # 3606 # "operations": [ 3607 # 3608 # "admin.access", 3609 # 3610 # "admin.org.read", 3611 # 3612 # "admin.org.update", 3613 # 3614 # "admin.user.create", 3615 # 3616 # "admin.user.read", 3617 # 3618 # "admin.user.update", 3619 # 3620 # "admin.user.delete", 3621 # 3622 # ... 3623 # 3624 # ] 3625 # 3626 # } 3627 # 3628 # } 3629 # } 3630 RightsListing : 3631 3632 # Retrieve the shared folders for an organization 3633 # Example: 3634 # Request: 3635 # query { 3636 # 3637 # sharedFolders { 3638 # 3639 # id 3640 # 3641 # } 3642 # } 3643 # Response: 3644 # { 3645 # 3646 # "data": { 3647 # 3648 # "sharedFolders": [] 3649 # 3650 # } 3651 # } 3652 Folder] : [ 3653 3654 # Retrieve multiple watchlists 3655 # Example: 3656 # Request: 3657 # query { 3658 # 3659 # watchlists(limit: 2) { 3660 # 3661 # records { 3662 # 3663 # id 3664 # 3665 # name 3666 # 3667 # } 3668 # 3669 # } 3670 # } 3671 # Response: 3672 # { 3673 # 3674 # "data": { 3675 # 3676 # "watchlists": { 3677 # 3678 # "records": [ 3679 # 3680 # { 3681 # 3682 # "id": "326916", 3683 # 3684 # "name": "example" 3685 # 3686 # }, 3687 # 3688 # { 3689 # 3690 # "id": "325791", 3691 # 3692 # "name": "example" 3693 # 3694 # } 3695 # 3696 # ] 3697 # 3698 # } 3699 # 3700 # } 3701 # } 3702 # 3703 # Arguments 3704 # isDisabled: Set `true` to include only disabled watchlist or 3705 # `false` to include only enabled watchlists. By default, 3706 # both are included. 3707 # names: Provide a list of names to filter folders 3708 ( 3709 ID, : 3710 DateTime, : 3711 DateTime, : 3712 DateTime, : 3713 DateTime, : 3714 String, : 3715 Int, : 3716 Int, : 3717 WatchlistOrderBy, : 3718 OrderDirection, : 3719 Boolean, : 3720 String], : [ 3721 StringMatch : 3722 ): WatchlistList 3723 3724 # Retrieve a single watchlist by id 3725 # Example: 3726 # Request: 3727 # query { 3728 # 3729 # watchlist(id: "325791") { 3730 # 3731 # name 3732 # 3733 # watchlistType 3734 # 3735 # } 3736 # } 3737 # Response: 3738 # { 3739 # 3740 # "data": { 3741 # 3742 # "watchlist": { 3743 # 3744 # "name": "example", 3745 # 3746 # "watchlistType": "tracking" 3747 # 3748 # } 3749 # 3750 # } 3751 # } 3752 ID!): Watchlist ( : 3753 3754 # Example: 3755 # Request: 3756 # query { 3757 # 3758 # mentionStatusOptions { 3759 # 3760 # id 3761 # 3762 # name 3763 # 3764 # } 3765 # } 3766 # Response: 3767 # { 3768 # 3769 # "data": { 3770 # 3771 # "mentionStatusOptions": [ 3772 # 3773 # { 3774 # 3775 # "id": "7", 3776 # 3777 # "name": "Auto Verified" 3778 # 3779 # }, 3780 # 3781 # { 3782 # 3783 # "id": "5", 3784 # 3785 # "name": "Invalid" 3786 # 3787 # }, 3788 # 3789 # { 3790 # 3791 # "id": "3", 3792 # 3793 # "name": "Needs Review" 3794 # 3795 # }, 3796 # 3797 # { 3798 # 3799 # "id": "1", 3800 # 3801 # "name": "Pending Verification" 3802 # 3803 # }, 3804 # 3805 # { 3806 # 3807 # "id": "6", 3808 # 3809 # "name": "Processing Verification" 3810 # 3811 # }, 3812 # 3813 # { 3814 # 3815 # "id": "4", 3816 # 3817 # "name": "Request Bonus" 3818 # 3819 # }, 3820 # 3821 # { 3822 # 3823 # "id": "2", 3824 # 3825 # "name": "Verified" 3826 # 3827 # } 3828 # 3829 # ] 3830 # 3831 # } 3832 # } 3833 MentionStatus!]! : [ 3834 3835 # Retrieve multiple data registries 3836 # Example: 3837 # Request: 3838 # query { 3839 # 3840 # dataRegistries(limit: 2) { 3841 # 3842 # records { 3843 # 3844 # id 3845 # 3846 # name 3847 # 3848 # } 3849 # 3850 # } 3851 # } 3852 # Response: 3853 # { 3854 # 3855 # "data": { 3856 # 3857 # "dataRegistries": { 3858 # 3859 # "records": [ 3860 # 3861 # { 3862 # 3863 # "id": "532ef261-d3a4-4c09-8fc7-0653a5131577", 3864 # 3865 # "name": "example" 3866 # 3867 # }, 3868 # 3869 # { 3870 # 3871 # "id": "317c941d-30d0-455e-882b-34a26e513364", 3872 # 3873 # "name": "example" 3874 # 3875 # } 3876 # 3877 # ] 3878 # 3879 # } 3880 # 3881 # } 3882 # } 3883 ( 3884 ID, : 3885 ID!], : [ 3886 String, : 3887 StringMatch, : 3888 Int, : 3889 Int, : 3890 DataRegistryOrderBy, : 3891 OrderDirection, : 3892 SchemaOwnership : 3893 ): DataRegistryList 3894 3895 # Retrieve a single data registry 3896 # Example: 3897 # Request: 3898 # query { 3899 # 3900 # dataRegistry(id: "532ef261-d3a4-4c09-8fc7-0653a5131577") { 3901 # 3902 # name 3903 # 3904 # organizationId 3905 # 3906 # source 3907 # 3908 # } 3909 # } 3910 # Response: 3911 # { 3912 # 3913 # "data": { 3914 # 3915 # "dataRegistry": { 3916 # 3917 # "name": "example", 3918 # 3919 # "organizationId": "35521", 3920 # 3921 # "source": "veritone-35521.datasets" 3922 # 3923 # } 3924 # 3925 # } 3926 # } 3927 ID!): DataRegistry ( : 3928 3929 # Retrieve a subscription by id 3930 # Example: 3931 # Request: 3932 # query { 3933 # 3934 # subscription(id: "275818") { 3935 # 3936 # isActive 3937 # 3938 # jsondata 3939 # 3940 # } 3941 # } 3942 # Response: 3943 # { 3944 # 3945 # "data": { 3946 # 3947 # "subscription": { 3948 # 3949 # "isActive": true, 3950 # 3951 # "jsondata": { 3952 # 3953 # "tracking_unit_id": "325791", 3954 # 3955 # "creator_email": "example email", 3956 # 3957 # "unsubscribe_hash": 3958 # "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0cmFja2luZ1VuaXQiOiJ0cmFja2luZ191bml0X2lkIiwiZW1haWxBZGRyZXNzIjoiZW1haWxfYWRkcmVzcyIsInRyYWNraW5nX3VuaXRfaWQiOiIzMjU3OTEiLCJlbWFpbF9hZGRyZXNzIjoiZXhhbXBsZSBlbWFpbCIsImlhdCI6MTYyNDAyMjY4OCwiaXNzIjoidmVyaXRvbmU6ZGlzY292ZXJ5Iiwic3ViIjoidW5zdWJzY3JpYmUifQ.stYGS_goXaEhwLbKtYRohPirUT-q6vuY5hMHt74BWMUuEWYhwAQBxMItoFjZSXc3lHolQutxsl_BDiMOWNS4snRvcn-jI-5HG_4A3gEjQc6sYbgtyeVGxuDAg4urtj5sSBz0AU0xXZwLp2NI0Q39dqQSi1v1ZFANFE-jGULHreE3h617hLKf6CvegaOyrn_wqNONsB6VKDbXoLxdWoYJu3k7UztbvD1SC_bYHc7ltd1Ua2blUXSH0eBlk7pSv1vWdpw9KwMeuPJdC3R3qOB3-0xtp7KzTs0f5TelSZbk-6keVJz4LQt2mDxs6uivd8wb6GJ6Ikw-uKUYuo3T-vL0p-hFA5DkwiToomqTIqXvF5DGJxx762bKLLEKALAC55LdJ7eCZc6DmrnRbYLYNVfc2jK9YBDKeZxUAjNmYvlRsQTpLIrLoxWWmCbOJznfEjrzp_gI24rUh5qZ_-KUHr0pEYd5DuURy_geCmwSedq-nHV8tlE7op1bX8k9fwWFjIS7JIjYquUJq9T2wqIORO0WN6DGhgqkL7texbx9IYSWRkAY26KQxUF08jm5Vh_jrkmRyXsS9r5kVn_AGXbMA_HqtFo2jvXw5OXDcuaRjYwJpf8YtMvjNuDl8t9gbSmKwbeG1FsErPX0ne5K2TRWIqolohIvdHTTfsZLVvWdwmASnYw" 3959 # 3960 # } 3961 # 3962 # } 3963 # 3964 # } 3965 # } 3966 ID!): Subscription! ( : 3967 3968 ID!): CognitiveSearch! ( : 3969 3970 # Retrieve multiple collections 3971 # Example: 3972 # Request: 3973 # query { 3974 # 3975 # collections { 3976 # 3977 # records { 3978 # 3979 # id 3980 # 3981 # name 3982 # 3983 # } 3984 # 3985 # } 3986 # } 3987 # Response: 3988 # { 3989 # 3990 # "data": { 3991 # 3992 # "collections": { 3993 # 3994 # "records": [ 3995 # 3996 # { 3997 # 3998 # "id": "241121", 3999 # 4000 # "name": "example" 4001 # 4002 # }, 4003 # 4004 # { 4005 # 4006 # "id": "242599", 4007 # 4008 # "name": "example" 4009 # 4010 # }, 4011 # 4012 # { 4013 # 4014 # "id": "243625", 4015 # 4016 # "name": "example" 4017 # 4018 # } 4019 # 4020 # ] 4021 # 4022 # } 4023 # 4024 # } 4025 # } 4026 ID, : String, : ID, : Int, : Int): CollectionList! ( : 4027 4028 # Retrieve a collection by id 4029 # Example: 4030 # Request: 4031 # query { 4032 # 4033 # collection(id: "241121") { 4034 # 4035 # name 4036 # 4037 # isActive 4038 # 4039 # } 4040 # } 4041 # Response: 4042 # { 4043 # 4044 # "data": { 4045 # 4046 # "collection": { 4047 # 4048 # "name": "example", 4049 # 4050 # "isActive": true 4051 # 4052 # } 4053 # 4054 # } 4055 # } 4056 ID!): Collection! ( : 4057 4058 ID!, : ID!): CollectionMention! ( : 4059 4060 # Retrieve a list of collection mentions 4061 # Specify at least one of folderId or mentionId 4062 ( 4063 ID, : 4064 ID, : 4065 CollectionMentionOrderBy, : 4066 Int, : 4067 Int : 4068 ): CollectionMentionList! 4069 4070 # Retrieve multiple mentions 4071 # Example: 4072 # Request: 4073 # query { 4074 # 4075 # mentions { 4076 # 4077 # records { 4078 # 4079 # id 4080 # 4081 # } 4082 # 4083 # } 4084 # } 4085 # Response: 4086 # { 4087 # 4088 # "data": { 4089 # 4090 # "mentions": { 4091 # 4092 # "records": [] 4093 # 4094 # } 4095 # 4096 # } 4097 # } 4098 # 4099 # Arguments 4100 # watchlistId: Get mentions created from the specified watchlist 4101 # sourceId: Get mentions associated with the specified source 4102 # sourceTypeId: Get mentions associated with sources of the 4103 # specified source type 4104 # tdoId: Get mentions associated directly with the specific TDO 4105 # dateTimeFilter: Specify date/time filters against mention 4106 # fields. 4107 # Querying for mentions can be expensive. If the query does not 4108 # include a filter by `id`, `tdoId`, `sourceId`, `watchlistId`, or 4109 # a user-provided `dateTimeFilter`, a default filter of the 4110 # past 7 days is applied. 4111 # orderBy: Set order information on the query. Multiple fields 4112 # are supported. 4113 # folderId: Provide a folder ID to filter by collection 4114 ( 4115 ID, : 4116 ID, : 4117 ID, : 4118 ID, : 4119 ID, : 4120 MentionDateTimeFilter!], : [ 4121 MentionOrderBy!], : [ 4122 Int, : 4123 Int, : 4124 ID : 4125 ): MentionList 4126 4127 # Retrieves engine results by TDO and engine ID or by job ID. 4128 # Example: 4129 # Request: 4130 # query { 4131 # 4132 # engineResults( 4133 # 4134 # tdoId: "1580507556", 4135 # 4136 # engineIds: "4") { 4137 # 4138 # sourceId 4139 # 4140 # records { 4141 # 4142 # tdoId 4143 # 4144 # } 4145 # 4146 # } 4147 # } 4148 # Response: 4149 # { 4150 # 4151 # "data": { 4152 # 4153 # "engineResults": { 4154 # 4155 # "sourceId": null, 4156 # 4157 # "records": [] 4158 # 4159 # } 4160 # 4161 # } 4162 # } 4163 # 4164 # Arguments 4165 # tdoId: Provide the ID of the TDO containing engine results to 4166 # retrieve. 4167 # If this parameter is used, engineIds or engineCategoryIds must also be set. 4168 # Results for _only_ the specified TDO will be returned. 4169 # sourceId: Provide the ID of the Source containing engine 4170 # results to retrieve. 4171 # If this parameter is used, engineIds or engineCategoryIds must also be set. 4172 # This takes priority over tdoId. 4173 # engineIds: Provide one or more engine IDs to retrieve engine 4174 # results by 4175 # ID. This parameter is mandatory if tdoId is used, but optional 4176 # if jobId or engineCategory is used. 4177 # engineCategoryIds: Provide one or more category IDs to get all 4178 # results from that categroy. 4179 # jobId: Provide a job ID to retrieve engine results for the job. 4180 # mentionId: Provide a mention ID to retrieve engine results for 4181 # the mention. 4182 # startOffsetMs: Start offset ms for the results. 4183 # stopOffsetMs: End offset ms for the results. 4184 # startDate: Start date for the results. Takes priority over 4185 # startOffsetMs. 4186 # stopDate: End date for the results. Takes priority over 4187 # stopOffsetMs. 4188 # ignoreUserEdited: Whether or not to exclude user edited engine 4189 # results. Defaults to false. 4190 # fallbackTdoId: A TDO ID can be provided for use if the provided 4191 # `sourceId` and/or 4192 # `mentionId` parameters do not resolve to a logical set of TDOs. 4193 # Depending on parameter settings and available data, 4194 # results from other TDOs can be included in the response. 4195 ( 4196 ID, : 4197 ID, : 4198 ID!], : [ 4199 ID!], : [ 4200 ID, : 4201 ID, : 4202 Int, : 4203 Int, : 4204 DateTime, : 4205 DateTime, : 4206 Boolean, : 4207 ID : 4208 ): EngineResultList 4209 4210 # Retrieve a trigger by id 4211 # Example: 4212 # Request: 4213 # query { 4214 # 4215 # trigger(id: "2998") { 4216 # 4217 # target 4218 # 4219 # createdDateTime 4220 # 4221 # } 4222 # } 4223 # Response: 4224 # { 4225 # 4226 # "data": { 4227 # 4228 # "trigger": { 4229 # 4230 # "target": "Email", 4231 # 4232 # "createdDateTime": "2021-06-18T13:35:08.631Z" 4233 # 4234 # } 4235 # 4236 # } 4237 # } 4238 ID!): Trigger ( : 4239 4240 # Retrieve triggers 4241 # Example: 4242 # Request: 4243 # query { 4244 # 4245 # triggers { 4246 # 4247 # id 4248 # 4249 # } 4250 # } 4251 # Response: 4252 # { 4253 # 4254 # "data": { 4255 # 4256 # "triggers": [ 4257 # 4258 # { 4259 # 4260 # "id": "2998" 4261 # 4262 # } 4263 # 4264 # ] 4265 # 4266 # } 4267 # } 4268 Trigger] : [ 4269 4270 # Fetch all saved searches that the current user has made 4271 # Fetch all saved searches that have been shared with 4272 # the current users organization 4273 # Include any saved searches that the user has created 4274 # Example: 4275 # Request: 4276 # query { 4277 # 4278 # savedSearches { 4279 # 4280 # records { 4281 # 4282 # id 4283 # 4284 # name 4285 # 4286 # } 4287 # 4288 # } 4289 # } 4290 # Response: 4291 # { 4292 # 4293 # "data": { 4294 # 4295 # "savedSearches": { 4296 # 4297 # "records": [ 4298 # 4299 # { 4300 # 4301 # "id": "3aa9fecb-d3cb-4fa5-a11b-20e02ae494b9", 4302 # 4303 # "name": "example" 4304 # 4305 # } 4306 # 4307 # ] 4308 # 4309 # } 4310 # 4311 # } 4312 # } 4313 ( 4314 Int, : 4315 Int, : 4316 Boolean, : 4317 String, : 4318 SavedSearchOrderBy, : 4319 OrderDirection : 4320 ): SavedSearchList! 4321 4322 # Retrieve a list of export requests 4323 # Example: 4324 # Request: 4325 # query { 4326 # 4327 # exportRequests(limit: 2) { 4328 # 4329 # records { 4330 # 4331 # id 4332 # 4333 # organizationId 4334 # 4335 # } 4336 # 4337 # } 4338 # } 4339 # Response: 4340 # { 4341 # 4342 # "data": { 4343 # 4344 # "exportRequests": { 4345 # 4346 # "records": [ 4347 # 4348 # { 4349 # 4350 # "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad", 4351 # 4352 # "organizationId": "35521" 4353 # 4354 # } 4355 # 4356 # ] 4357 # 4358 # } 4359 # 4360 # } 4361 # } 4362 # 4363 # Arguments 4364 # id: Provide an ID to retrieve a single export request 4365 # offset: Provide an offset to skip to a certain element in the 4366 # result, for paging. 4367 # limit: Specify maximum number of results to retrieve in this 4368 # result. Page size. 4369 # status: Provide a list of status options to filter by status 4370 # event: Provide an event to retrieve export request. Should be 4371 # 'exportRequest' or 'mentionExportRequest' 4372 # Default value is 'exportRequest' 4373 ( 4374 ID, : 4375 Int, : 4376 Int, : 4377 ExportRequestStatus!], : [ 4378 ExportRequestEvent : 4379 ): ExportRequestList! 4380 4381 # Retrieve a single export request by id 4382 # Example: 4383 # Request: 4384 # query { 4385 # 4386 # exportRequest(id: "938b2d64-6df1-486b-b6ea-29d33dee49ad") { 4387 # 4388 # id 4389 # 4390 # organizationId 4391 # 4392 # requestorId 4393 # 4394 # status 4395 # 4396 # } 4397 # } 4398 # Response: 4399 # { 4400 # 4401 # "data": { 4402 # 4403 # "exportRequest": { 4404 # 4405 # "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad", 4406 # 4407 # "organizationId": "35521", 4408 # 4409 # "requestorId": "59cb4e74-7c31-4267-b91e-d4600bc08008", 4410 # 4411 # "status": "complete" 4412 # 4413 # } 4414 # 4415 # } 4416 # } 4417 # 4418 # Arguments 4419 # event: Provide an event to retrieve export request. Should be 4420 # 'exportRequest' or 'mentionExportRequest' 4421 # Default value is 'exportRequest' 4422 ID!, : ExportRequestEvent): ExportRequest! ( : 4423 4424 # Retrieve a event by id 4425 # Example: 4426 # Request: 4427 # query { 4428 # 4429 # event(id: "55fc7c51-1521-4043-902f-f0f3a357da6d") { 4430 # 4431 # eventName 4432 # 4433 # eventType 4434 # 4435 # description 4436 # 4437 # } 4438 # } 4439 # Response: 4440 # { 4441 # 4442 # "data": { 4443 # 4444 # "event": { 4445 # 4446 # "eventName": "example", 4447 # 4448 # "eventType": "example", 4449 # 4450 # "description": "new example description" 4451 # 4452 # } 4453 # 4454 # } 4455 # } 4456 ID!): Event ( : 4457 4458 # Retrieve a list of events by application 4459 # Example: 4460 # Request: 4461 # query { 4462 # 4463 # events( 4464 # 4465 # application: "system", 4466 # 4467 # limit: 2) { 4468 # 4469 # records { 4470 # 4471 # id 4472 # 4473 # eventName 4474 # 4475 # } 4476 # 4477 # } 4478 # } 4479 # Response: 4480 # { 4481 # 4482 # "data": { 4483 # 4484 # "events": { 4485 # 4486 # "records": [ 4487 # 4488 # { 4489 # 4490 # "id": "8876aa2f-1068-411d-b746-28c867c151cc", 4491 # 4492 # "eventName": "ActionTokenForbidden" 4493 # 4494 # }, 4495 # 4496 # { 4497 # 4498 # "id": "d5082d0e-3c96-4c71-9f27-c679650f2adf", 4499 # 4500 # "eventName": "ActionUserForbidden" 4501 # 4502 # } 4503 # 4504 # ] 4505 # 4506 # } 4507 # 4508 # } 4509 # } 4510 # 4511 # Arguments 4512 # application: Provide an application to retrieve all its events. 4513 # Use 'system' to list all public system events. 4514 # offset: Provide an offset to skip to a certain element in the 4515 # result, for paging. 4516 # limit: Specify maximum number of results to retrieve in this 4517 # result. Page size. 4518 String!, : Int, : Int): EventList! ( : 4519 4520 # Retrieve a list of subscriptions by organization 4521 # Example: 4522 # Request: 4523 # query { 4524 # 4525 # eventSubscriptions(limit: 2) { 4526 # 4527 # records { 4528 # 4529 # id 4530 # 4531 # eventName 4532 # 4533 # } 4534 # 4535 # } 4536 # } 4537 # Response: 4538 # { 4539 # 4540 # "data": { 4541 # 4542 # "eventSubscriptions": { 4543 # 4544 # "records": [ 4545 # 4546 # { 4547 # 4548 # "id": "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194", 4549 # 4550 # "eventName": "LibraryTrainingComplete" 4551 # 4552 # }, 4553 # 4554 # { 4555 # 4556 # "id": "c7c4a969-4500-4d7b-b77f-81b1e64bf112", 4557 # 4558 # "eventName": "LibraryTrainingComplete" 4559 # 4560 # } 4561 # 4562 # ] 4563 # 4564 # } 4565 # 4566 # } 4567 # } 4568 # 4569 # Arguments 4570 # ids: The event subscription ids 4571 # eventName: The name of the event 4572 # eventType: The type of event, such as `mention`, `job`, 4573 # `engine`. 4574 # offset: Provide an offset to skip to a certain element in the 4575 # result, for paging. 4576 # limit: Specify maximum number of results to retrieve in this 4577 # result. Page size. 4578 # orgId: The organization ID with which these event subscriptions 4579 # are associated. 4580 # appId: The application ID with which these event subscriptions 4581 # are associated. 4582 # scope: Event subscription scope 4583 ( 4584 ID!], : [ 4585 String, : 4586 String, : 4587 Int, : 4588 Int, : 4589 ID, : 4590 ID, : 4591 EventSubscriptionScope : 4592 ): EventSubscriptionList! 4593 4594 # Retrieve a subscription by id 4595 # Example: 4596 # Request: 4597 # query { 4598 # 4599 # eventSubscription(id: "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194") { 4600 # 4601 # id 4602 # 4603 # organizationId 4604 # 4605 # eventName 4606 # 4607 # targetName 4608 # 4609 # } 4610 # } 4611 # Response: 4612 # { 4613 # 4614 # "data": { 4615 # 4616 # "eventSubscription": { 4617 # 4618 # "id": "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194", 4619 # 4620 # "organizationId": "35521", 4621 # 4622 # "eventName": "LibraryTrainingComplete", 4623 # 4624 # "targetName": "NotificationMailbox" 4625 # 4626 # } 4627 # 4628 # } 4629 # } 4630 ID!): EventSubscription! ( : 4631 4632 # Example: 4633 # Request: 4634 # query { 4635 # 4636 # eventActionTemplate(id: "d02522d7-ef5f-448f-981a-d2cfc7603d92") { 4637 # 4638 # organizationId 4639 # 4640 # actionType 4641 # 4642 # name 4643 # 4644 # } 4645 # } 4646 # Response: 4647 # { 4648 # 4649 # "data": { 4650 # 4651 # "eventActionTemplate": { 4652 # 4653 # "organizationId": "35521", 4654 # 4655 # "actionType": "job", 4656 # 4657 # "name": "example" 4658 # 4659 # } 4660 # 4661 # } 4662 # } 4663 ID!): EventActionTemplate ( : 4664 4665 # Example: 4666 # Request: 4667 # query { 4668 # 4669 # eventActionTemplates( 4670 # 4671 # inputType: event, 4672 # 4673 # actionType: job 4674 # 4675 # limit:2) { 4676 # 4677 # records { 4678 # 4679 # id 4680 # 4681 # name 4682 # 4683 # } 4684 # 4685 # } 4686 # } 4687 # Response: 4688 # { 4689 # 4690 # "data": { 4691 # 4692 # "eventActionTemplates": { 4693 # 4694 # "records": [ 4695 # 4696 # { 4697 # 4698 # "id": "d02522d7-ef5f-448f-981a-d2cfc7603d92", 4699 # 4700 # "name": "example" 4701 # 4702 # }, 4703 # 4704 # { 4705 # 4706 # "id": "49d28375-b6b2-418e-b965-8e939d1189ae", 4707 # 4708 # "name": "example" 4709 # 4710 # } 4711 # 4712 # ] 4713 # 4714 # } 4715 # 4716 # } 4717 # } 4718 # 4719 # Arguments 4720 # ownerApplicationId: The application id 4721 # inputType: use "event" for now. In the future, we allow 4722 # additional input_type types. For example, a schedule or a tweet. 4723 # actionType: Either "job", "webhook", "sms", "email". Future 4724 # action_type could be "gql" where action is purely a function call. 4725 # offset: Provide an offset to skip to a certain element in the 4726 # result, for paging. 4727 # limit: Specify maximum number of results to retrieve in this 4728 # result. Page size. 4729 ( 4730 ID, : 4731 EventActionTemplateInputType, : 4732 EventActionTemplateActionType, : 4733 Int, : 4734 Int : 4735 ): EventActionTemplateList! 4736 4737 # Example: 4738 # Request: 4739 # query { 4740 # 4741 # eventCustomRule(id: "c2c1ee13-37d2-4f92-9156-5cb1a3c59ed5") { 4742 # 4743 # name 4744 # 4745 # eventName 4746 # 4747 # description 4748 # 4749 # } 4750 # } 4751 # Response: 4752 # { 4753 # 4754 # "data": { 4755 # 4756 # "eventCustomRule": { 4757 # 4758 # "name": "example", 4759 # 4760 # "eventName": "example", 4761 # 4762 # "description": "example description" 4763 # 4764 # } 4765 # 4766 # } 4767 # } 4768 ID!): EventCustomRule ( : 4769 4770 # Example: 4771 # Request: 4772 # query { 4773 # 4774 # eventCustomRules(limit: 2) { 4775 # 4776 # records { 4777 # 4778 # id 4779 # 4780 # name 4781 # 4782 # } 4783 # 4784 # } 4785 # } 4786 # Response: 4787 # { 4788 # 4789 # "data": { 4790 # 4791 # "eventCustomRules": { 4792 # 4793 # "records": [ 4794 # 4795 # { 4796 # 4797 # "id": "c2c1ee13-37d2-4f92-9156-5cb1a3c59ed5", 4798 # 4799 # "name": "example" 4800 # 4801 # } 4802 # 4803 # ] 4804 # 4805 # } 4806 # 4807 # } 4808 # } 4809 # 4810 # Arguments 4811 # offset: the offset to skip to a certain element in the result 4812 # limit: the maximum number of rows in the results 4813 Int, : Int): EventCustomRuleList! ( : 4814 4815 # This query returns information about time zones recognized by this 4816 # 4817 # server. The information is static and does not change. 4818 # 4819 # Example: 4820 # 4821 # Request: 4822 # 4823 # query { 4824 # 4825 # timeZones { 4826 # 4827 # name 4828 # 4829 # abbreviations{ 4830 # 4831 # name 4832 # 4833 # } 4834 # 4835 # } 4836 # } 4837 # Response: 4838 # { 4839 # 4840 # "data": { 4841 # 4842 # "timeZones": [ 4843 # 4844 # { 4845 # 4846 # "name": "Africa/Abidjan", 4847 # 4848 # "abbreviations": [ 4849 # 4850 # { 4851 # 4852 # "name": "GMT" 4853 # 4854 # } 4855 # 4856 # ] 4857 # 4858 # }, 4859 # 4860 # { 4861 # 4862 # "name": "Africa/Accra", 4863 # 4864 # "abbreviations": [ 4865 # 4866 # { 4867 # 4868 # "name": "GMT" 4869 # 4870 # }, 4871 # 4872 # { 4873 # 4874 # "name": "+0020" 4875 # 4876 # } 4877 # 4878 # ] 4879 # 4880 # }, 4881 # 4882 # { 4883 # 4884 # "name": "Africa/Lagos", 4885 # 4886 # "abbreviations": [ 4887 # 4888 # { 4889 # 4890 # "name": "WAT" 4891 # 4892 # } 4893 # 4894 # ] 4895 # 4896 # }, 4897 # 4898 # ... 4899 # 4900 # ... 4901 # 4902 # ] 4903 # 4904 # } 4905 # 4906 # ] 4907 # 4908 # } 4909 # } 4910 TimeZone!]! : [ 4911 4912 # Examine entries from the audit log. All operations that modify data are 4913 # written to the audit log. Only entries for the user's own organization 4914 # can be queried. 4915 # All queries are bracketed by a time window. A default time window is applied 4916 # if the `toDateTime` and/or `fromDateTime` parameters are not provided. 4917 # The maximum time window length is 30 days. 4918 # Only Veritone and organization administrators can use this query. 4919 # Example: 4920 # Request: 4921 # query { 4922 # 4923 # auditLog(limit: 2) { 4924 # 4925 # records { 4926 # 4927 # id 4928 # 4929 # objectId 4930 # 4931 # description 4932 # 4933 # } 4934 # 4935 # } 4936 # } 4937 # Response: 4938 # { 4939 # 4940 # "data": { 4941 # 4942 # "auditLog": { 4943 # 4944 # "records": [ 4945 # 4946 # { 4947 # 4948 # "id": "735915311", 4949 # 4950 # "objectId": "*********", 4951 # 4952 # "description": "Changed password" 4953 # 4954 # }, 4955 # 4956 # { 4957 # 4958 # "id": "735915307", 4959 # 4960 # "objectId": "********", 4961 # 4962 # "description": "Changed password" 4963 # 4964 # } 4965 # 4966 # ] 4967 # 4968 # } 4969 # 4970 # } 4971 # } 4972 # 4973 # Arguments 4974 # toDateTime: Date/time up to which entries will be returned. In 4975 # other words, the 4976 # end of the query time window. 4977 # Defaults to the current time. 4978 # fromDateTime: Date/time from which entries will be returned. In 4979 # other words, the 4980 # start of the query time window. 4981 # Defaults to the `toDateTime` minus 7 days. 4982 # organizationId: Organization ID to query records for. This 4983 # value can only be used by 4984 # Veritone administrators. Any value provided by user administrators will 4985 # be ignored. 4986 # userName: User name on audit entry. Must be exact match. 4987 # clientIpAddress: IP address of the client that generated the 4988 # audit action. Must be exact match. 4989 # clientUserAgent: HTTP user agent of the client that generated 4990 # the audit action. Must be exact match. 4991 # eventType: The event type, such as `Create`, `Update`, or 4992 # `Delete`. 4993 # Must be exact match. 4994 # objectId: The ID of the object involved in the audit action. 4995 # The format of this ID 4996 # varies by object type. Must be exact match. 4997 # objectType: The type of the object involved in the audit 4998 # action, such as `Watchlist` 4999 # or `TemporalDataObject`. Must be exact match. 5000 # success: Whether or not the action was successful. 5001 # id: The unique ID of an audit log entry. Multiple values can be 5002 # provided. 5003 # offset: Offset into result set, for paging. 5004 # limit: Limit on result size, for paging (page size). Audit 5005 # queries are 5006 # lightweight so the default of 100 is higher than the default offset 5007 # used elsewhere in the API. 5008 # orderBy: Order information. Default is order by 5009 # `createdDateTime` descending. 5010 ( 5011 DateTime, : 5012 DateTime, : 5013 ID, : 5014 String, : 5015 String, : 5016 String, : 5017 String, : 5018 ID, : 5019 String, : 5020 Boolean, : 5021 ID!], : [ 5022 Int, : 5023 Int, : 5024 AuditLogOrderBy!] : [ 5025 ): AuditLogEntryList! 5026 5027 # Get the media share by media shareId 5028 ID!): MediaShare! ( : 5029 5030 # Retrieve a shared collection 5031 # 5032 # Arguments 5033 # shareId: share token 5034 ID!): SharedCollection ( : 5035 5036 # Retrieve shared collection history records 5037 # Example: 5038 # Request: 5039 # query { 5040 # 5041 # sharedCollectionHistory(limit: 2, 5042 # 5043 # folderId: "d551fbd6-7354-4b0e-abfb-654ab8583be2") { 5044 # 5045 # records { 5046 # 5047 # id 5048 # 5049 # status 5050 # 5051 # shareId 5052 # 5053 # } 5054 # 5055 # } 5056 # } 5057 # Response: 5058 # { 5059 # 5060 # "data": { 5061 # 5062 # "sharedCollectionHistory": { 5063 # 5064 # "records": [] 5065 # 5066 # } 5067 # 5068 # } 5069 # } 5070 # 5071 # Arguments 5072 # ids: Provide an ID to retrieve a single history record 5073 # folderId: Provide a folder ID to filter by collection 5074 # shareId: Provide a share ID to filter by share ID 5075 # offset: Specify maximum number of results to retrieve in this 5076 # result. Page size. 5077 # limit: Specify maximum number of results to retrieve in this 5078 # result. 5079 ( 5080 ID!], : [ 5081 ID, : 5082 String, : 5083 Int, : 5084 Int : 5085 ): SharedCollectionHistoryList! 5086 5087 # Get list process templates by id or current organizationId 5088 # Example: 5089 # Request: 5090 # query { 5091 # 5092 # processTemplates(limit: 2) { 5093 # 5094 # records { 5095 # 5096 # id 5097 # 5098 # organizationId 5099 # 5100 # name 5101 # 5102 # } 5103 # 5104 # } 5105 # } 5106 # Response: 5107 # { 5108 # 5109 # "data": { 5110 # 5111 # "processTemplates": { 5112 # 5113 # "records": [ 5114 # 5115 # { 5116 # 5117 # "id": "762", 5118 # 5119 # "organizationId": "35521", 5120 # 5121 # "name": "example" 5122 # 5123 # } 5124 # 5125 # ] 5126 # 5127 # } 5128 # 5129 # } 5130 # } 5131 ID, : Int, : Int): ProcessTemplateList! ( : 5132 5133 # Get process templates by id 5134 # Example: 5135 # Request: 5136 # query { 5137 # 5138 # processTemplate(id: "762") { 5139 # 5140 # name 5141 # 5142 # organizationId 5143 # 5144 # } 5145 # } 5146 # Response: 5147 # { 5148 # 5149 # "data": { 5150 # 5151 # "processTemplate": { 5152 # 5153 # "name": "example", 5154 # 5155 # "organizationId": "35521" 5156 # 5157 # } 5158 # 5159 # } 5160 # } 5161 ID!): ProcessTemplate! ( : 5162 5163 # Get creative by id with current organizationId 5164 # Example: 5165 # Request: 5166 # query { 5167 # 5168 # creative(id: "25209") { 5169 # 5170 # organizationId 5171 # 5172 # brandId 5173 # 5174 # } 5175 # } 5176 # Response: 5177 # { 5178 # 5179 # "data": { 5180 # 5181 # "creative": { 5182 # 5183 # "organizationId": "35521", 5184 # 5185 # "brandId": null 5186 # 5187 # } 5188 # 5189 # } 5190 # } 5191 ID!): Creative! ( : 5192 5193 # Retrieve list of engine classes 5194 # Example: 5195 # Request: 5196 # query { 5197 # 5198 # engineClasses(limit: 2) { 5199 # 5200 # records { 5201 # 5202 # id 5203 # 5204 # name 5205 # 5206 # description 5207 # 5208 # } 5209 # 5210 # } 5211 # } 5212 # Response: 5213 # { 5214 # 5215 # "data": { 5216 # 5217 # "engineClasses": { 5218 # 5219 # "records": [ 5220 # 5221 # { 5222 # 5223 # "id": "e0283fdf-7f85-472e-b367-59cc8d205ba7", 5224 # 5225 # "name": "audio", 5226 # 5227 # "description": "The input to engines in the Audio class is an audio or video 5228 # file or stream. If your engine processes human speech or voice, it likely 5229 # belongs in the Speech class instead. Audio engines may recognize a specific 5230 # audio segment, such as an advertisement, identify sounds like that of a crying 5231 # baby or detect the presence of audio or music in an audio or video file, for 5232 # example." 5233 # 5234 # }, 5235 # 5236 # { 5237 # 5238 # "id": "1bcfdd35-1e9b-4694-8273-00b19510d164", 5239 # 5240 # "name": "biometrics", 5241 # 5242 # "description": "The input to engines in the Biometrics class may be an image, 5243 # speech or other audio or video file or stream. By definition, the Biometrics 5244 # class covers cognitive analysis related to data points from the human body. 5245 # Biometrics engines may detect or recognize faces, identify face attributes to 5246 # estimate a person's age or ethnicity or verify a person based on their unique 5247 # iris, for example." 5248 # 5249 # } 5250 # 5251 # ] 5252 # 5253 # } 5254 # 5255 # } 5256 # } 5257 # 5258 # Arguments 5259 # id: Provide an ID to retrieve a single specific engine class. 5260 # name: Provide a name, or part of one, to search by class name 5261 # offset: Specify maximum number of results to retrieve in this 5262 # result. Page size. 5263 # limit: Specify maximum number of results to retrieve in this 5264 # result. 5265 ID, : String, : Int, : Int): EngineClassList ( : 5266 5267 # Retrieve a specific engine class 5268 # Example: 5269 # Request: 5270 # query { 5271 # 5272 # engineClass(id: "e0283fdf-7f85-472e-b367-59cc8d205ba7") { 5273 # 5274 # id 5275 # 5276 # name 5277 # 5278 # description 5279 # 5280 # } 5281 # } 5282 # Response: 5283 # { 5284 # 5285 # "data": { 5286 # 5287 # "engineClass": { 5288 # 5289 # "id": "e0283fdf-7f85-472e-b367-59cc8d205ba7", 5290 # 5291 # "name": "audio", 5292 # 5293 # "description": "The input to engines in the Audio class is an audio or video 5294 # file or stream. If your engine processes human speech or voice, it likely 5295 # belongs in the Speech class instead. Audio engines may recognize a specific 5296 # audio segment, such as an advertisement, identify sounds like that of a crying 5297 # baby or detect the presence of audio or music in an audio or video file, for 5298 # example." 5299 # 5300 # } 5301 # 5302 # } 5303 # } 5304 # 5305 # Arguments 5306 # id: Supply the ID of the engine class to retrieve 5307 ID!): EngineClass ( : 5308 5309 # Retrieve list entity tags where tag key contains user input 5310 # Example: 5311 # Request: 5312 # query { 5313 # 5314 # matchEntityTags(input: { tagKey: "test}) { 5315 # 5316 # records { 5317 # 5318 # tagKey 5319 # 5320 # tagValue 5321 # 5322 # } 5323 # 5324 # } 5325 # } 5326 # Response: 5327 # { 5328 # 5329 # "data": { 5330 # 5331 # "matchEntityTags": { 5332 # 5333 # "records": [ 5334 # 5335 # { 5336 # 5337 # "tagKey": "test-tag", 5338 # 5339 # "tagValue": "test-value" 5340 # 5341 # }, 5342 # 5343 # { 5344 # 5345 # "tagKey": "another-testtag", 5346 # 5347 # "tagValue": "" 5348 # 5349 # }, 5350 # 5351 # ] 5352 # 5353 # } 5354 # 5355 # } 5356 # } 5357 # 5358 # Arguments 5359 # input: User provided text and entity type input. 5360 # offset: Specify maximum number of results to retrieve in this 5361 # result. Page size. 5362 # limit: Specify maximum number of results to retrieve in this 5363 # result. 5364 MatchEntityTagInput!, : Int, : Int): MatchedEntityTagsList ( : 5365 5366 # Returns all custom dashboards created by user 5367 # Example: 5368 # Request: 5369 # query { 5370 # 5371 # customDashboards { 5372 # 5373 # records { 5374 # 5375 # id 5376 # 5377 # description 5378 # 5379 # hostAppId 5380 # 5381 # } 5382 # 5383 # } 5384 # } 5385 # Response: 5386 # { 5387 # 5388 # "data": { 5389 # 5390 # "customDashboards": { 5391 # 5392 # "records": [ 5393 # 5394 # { 5395 # 5396 # "id": "a20ae938-e827-4b0b-a62a-6c9af0b98cc9", 5397 # 5398 # "description": "example", 5399 # 5400 # "hostAppId": "80354999-d633-4595-9578-d82f59a5134f" 5401 # 5402 # } 5403 # 5404 # ] 5405 # 5406 # } 5407 # 5408 # } 5409 # } 5410 # 5411 # Arguments 5412 # offset: Provide an offset to skip to a certain element in the 5413 # result, for paging. 5414 # limit: Specify maximum number of results to retrieve in this 5415 # result. Page size. 5416 # hostAppId: Include only dashboards created by specific 5417 # host_app_id 5418 Int, : Int, : ID): CustomDashboardList ( : 5419 5420 # Returns custom dashboard by id 5421 # Example: 5422 # Request: 5423 # query { 5424 # 5425 # customDashboard(id: "a20ae938-e827-4b0b-a62a-6c9af0b98cc9") { 5426 # 5427 # hostAppId 5428 # 5429 # name 5430 # 5431 # } 5432 # } 5433 # Response: 5434 # { 5435 # 5436 # "data": { 5437 # 5438 # "customDashboard": { 5439 # 5440 # "hostAppId": "80354999-d633-4595-9578-d82f59a5134f", 5441 # 5442 # "name": "example" 5443 # 5444 # } 5445 # 5446 # } 5447 # } 5448 ID!): CustomDashboard ( : 5449 5450 # Gets engine usage for an organization based on their billing type. 5451 # Example: 5452 # Request: 5453 # query { 5454 # 5455 # getUsageByTaskType { 5456 # 5457 # totalDuration 5458 # 5459 # totalCost 5460 # 5461 # } 5462 # } 5463 # Response: 5464 # { 5465 # 5466 # "data": { 5467 # 5468 # "getUsageByTaskType": { 5469 # 5470 # "totalDuration": 0, 5471 # 5472 # "totalCost": "0" 5473 # 5474 # } 5475 # 5476 # } 5477 # } 5478 UsageByTaskType! : 5479 5480 # Retrives the specific Dataset 5481 # 5482 # Arguments 5483 # id: Supply the ID of the Dataset to retrieve 5484 ID!): Dataset ( : 5485 5486 # Retrieve list of Datasets 5487 # Example: 5488 # Request: 5489 # query { 5490 # 5491 # datasets(limit:2, filter: {operation:OR}) { 5492 # 5493 # records { 5494 # 5495 # datasetId 5496 # 5497 # name 5498 # 5499 # } 5500 # 5501 # } 5502 # } 5503 # Response: 5504 # { 5505 # 5506 # "data": { 5507 # 5508 # "datasets": { 5509 # 5510 # "records": [] 5511 # 5512 # } 5513 # 5514 # } 5515 # } 5516 # 5517 # Arguments 5518 # offset: Provide an offset to skip to a certain element in the 5519 # result, for paging. 5520 # limit: Specify maximum number of results to retrieve in this 5521 # result. Page size. 5522 # filter: Filters for Dataset attributes 5523 Int, : Int, : DatasetFilter): DatasetList ( : 5524 5525 # Arguments 5526 # datasetId: Supply the ID of the Dataset to retrieve 5527 # offset: Provide an offset to skip to a certain element in the 5528 # result, for paging. 5529 # limit: Specify maximum number of results to retrieve in this 5530 # result. Page size. 5531 # filter: Query to filter SDO. Supports operations such as and, 5532 # or, eq, gt, lt, etc. 5533 # TODO link to syntax documentation 5534 # orderBy: Order by 5535 ( 5536 ID!, : 5537 Int, : 5538 Int, : 5539 JSONData, : 5540 StructuredDataOrderBy!] : [ 5541 ): DatasetEntryList! 5542 5543 # Retrive list of Engine Replacement 5544 # Example: 5545 # Request: 5546 # query { 5547 # 5548 # taskReplacementEngines { 5549 # 5550 # records { 5551 # 5552 # sourceEngineId 5553 # 5554 # replacementEngineId 5555 # 5556 # } 5557 # 5558 # } 5559 # } 5560 # Response: 5561 # { 5562 # 5563 # "data": { 5564 # 5565 # "taskReplacementEngines": { 5566 # 5567 # "records": [ 5568 # 5569 # { 5570 # 5571 # "sourceEngineId": "1", 5572 # 5573 # "replacementEngineId": "2" 5574 # 5575 # } 5576 # 5577 # ] 5578 # 5579 # } 5580 # 5581 # } 5582 # } 5583 # 5584 # Arguments 5585 # organizationId: Only superadmin can get engine replacement of 5586 # other orgs 5587 # engineId: Filter by the source engineId 5588 # offset: Provide an offset to skip to a certain element in the 5589 # result, for paging. 5590 # limit: Specify maximum number of results to retrieve in this 5591 # result. Page size. 5592 ( 5593 ID, : 5594 ID, : 5595 Int, : 5596 Int : 5597 ): TaskReplacementEngineList 5598 5599 # Retrive Notification Mailboxes by list of mailboxIds 5600 # Example: 5601 # Request: 5602 # query { 5603 # 5604 # notificationMailboxes { 5605 # 5606 # id 5607 # 5608 # name 5609 # 5610 # } 5611 # } 5612 # Response: 5613 # { 5614 # 5615 # "data": { 5616 # 5617 # "notificationMailboxes": [ 5618 # 5619 # { 5620 # 5621 # "id": "6fda80b5-3d1a-4eb8-bd32-277be5104149", 5622 # 5623 # "name": "example" 5624 # 5625 # }, 5626 # 5627 # { 5628 # 5629 # "id": "d20e9f37-a887-41bb-aed0-3268884ecebc", 5630 # 5631 # "name": "Library training mailbox" 5632 # 5633 # }, 5634 # 5635 # { 5636 # 5637 # "id": "2d29533b-560e-4354-b794-84f823d33205", 5638 # 5639 # "name": "Library training mailbox" 5640 # 5641 # } 5642 # 5643 # ] 5644 # 5645 # } 5646 # } 5647 ID!]): [NotificationMailbox!] ( : [ 5648 5649 # Retrive Notification Templates 5650 # Example: 5651 # Request: 5652 # query { 5653 # 5654 # notificationTemplates(limit: 2) { 5655 # 5656 # records { 5657 # 5658 # id 5659 # 5660 # eventName 5661 # 5662 # } 5663 # 5664 # } 5665 # } 5666 # Response: 5667 # { 5668 # 5669 # "data": { 5670 # 5671 # "notificationTemplates": { 5672 # 5673 # "records": [ 5674 # 5675 # { 5676 # 5677 # "id": "3947b833-2be4-4415-8272-2cee62fbca23", 5678 # 5679 # "eventName": "example" 5680 # 5681 # } 5682 # 5683 # ] 5684 # 5685 # } 5686 # 5687 # } 5688 # } 5689 # 5690 # Arguments 5691 # ids: Get by array of ids 5692 # eventName: Get by eventName 5693 # eventType: Get by eventType 5694 # application: Get by application 5695 # mailboxId: Get by mailboxId 5696 # ownerOrganizationId: Only super-admin or orgless token can get 5697 # templates by ownerOrganizationId 5698 # offset: Provide an offset to skip to a certain element in the 5699 # result, for paging. 5700 # limit: Specify maximum number of results to retrieve in this 5701 # result. Page size. 5702 ( 5703 ID], : [ 5704 String, : 5705 String, : 5706 String, : 5707 ID, : 5708 ID, : 5709 Int, : 5710 Int : 5711 ): NotificationTemplateList 5712 5713 # Retrieve Notification Actions 5714 # Example: 5715 # Request: 5716 # query { 5717 # 5718 # notificationActions { 5719 # 5720 # records { 5721 # 5722 # id 5723 # 5724 # actionName 5725 # 5726 # } 5727 # 5728 # } 5729 # } 5730 # Response: 5731 # { 5732 # 5733 # "data": { 5734 # 5735 # "notificationActions": { 5736 # 5737 # "records": [ 5738 # 5739 # { 5740 # 5741 # "id": "866aad9c-9e68-4c33-b523-373bb332aea2", 5742 # 5743 # "actionName": "example" 5744 # 5745 # } 5746 # 5747 # ] 5748 # 5749 # } 5750 # 5751 # } 5752 # } 5753 # 5754 # Arguments 5755 # ids: Get by array of ids 5756 # eventName: Get by eventName 5757 # eventType: Get by eventType 5758 # application: Get by application 5759 # mailboxId: Get by mailboxId 5760 # ownerOrganizationId: Only super-admin or orgless token can get 5761 # templates by ownerOrganizationId 5762 # offset: Provide an offset to skip to a certain element in the 5763 # result, for paging. 5764 # limit: Specify maximum number of results to retrieve in this 5765 # result. Page size. 5766 ( 5767 ID], : [ 5768 String, : 5769 String, : 5770 String, : 5771 ID, : 5772 ID, : 5773 Int, : 5774 Int : 5775 ): NotificationActionList 5776 5777 # Retrieve Application user setting definitions 5778 # Example: 5779 # Request: 5780 # query { 5781 # 5782 # getUserSettingDefinitions(application: "80354999-d633-4595-9578-d82f59a5134f") { 5783 # 5784 # key 5785 # 5786 # value 5787 # 5788 # } 5789 # } 5790 # Response: 5791 # { 5792 # 5793 # "data": { 5794 # 5795 # "getUserSettingDefinitions": [ 5796 # 5797 # { 5798 # 5799 # "key": "example", 5800 # 5801 # "value": "example" 5802 # 5803 # } 5804 # 5805 # ] 5806 # 5807 # } 5808 # } 5809 # 5810 # Arguments 5811 # application: Specify the applicationId 5812 # key: Specify the key of user setting (optional) 5813 # organizationGuid: Specify the organizationGuid (require for 5814 # internal token) 5815 # This can be specified by superadmin to get user setting definitions of other 5816 # organization 5817 ( 5818 ID!, : 5819 String, : 5820 ID : 5821 ): [ApplicationSetting] 5822 5823 # Retrive User setting 5824 # Example: 5825 # Request: 5826 # query { 5827 # 5828 # getUserSettings { 5829 # 5830 # key 5831 # 5832 # applicationId 5833 # 5834 # } 5835 # } 5836 # Response: 5837 # { 5838 # 5839 # "data": { 5840 # 5841 # "getUserSettings": [ 5842 # 5843 # { 5844 # 5845 # "key": "example12", 5846 # 5847 # "applicationId": "80354999-d633-4595-9578-d82f59a5134f" 5848 # 5849 # } 5850 # 5851 # ] 5852 # 5853 # } 5854 # } 5855 # 5856 # Arguments 5857 # userId: Filter by userId (optional). 5858 # If it's not specified, default is current user 5859 # application: Filter by applicationId 5860 # keys: Filter by keys 5861 ID, : ID, : [String]): [UserSetting] ( : 5862 5863 # Example: 5864 # Request: 5865 # query { 5866 # 5867 # staticAppConfig { 5868 # 5869 # loginUrl 5870 # 5871 # apiRoot 5872 # 5873 # } 5874 # } 5875 # Response: 5876 # { 5877 # 5878 # "data": { 5879 # 5880 # "staticAppConfig": { 5881 # 5882 # "loginUrl": "https://login.veritone.com", 5883 # 5884 # "apiRoot": "https://api.veritone.com" 5885 # 5886 # } 5887 # 5888 # } 5889 # } 5890 StaticAppConfig! : 5891 5892 # Get OpenID Provider by id 5893 ID!): OpenIdProvider! ( : 5894 5895 # Get OpenID Provides 5896 # Example: 5897 # Request: 5898 # query { 5899 # 5900 # openIdProviders { 5901 # 5902 # records { 5903 # 5904 # id 5905 # 5906 # isGlobal 5907 # 5908 # websiteUrl 5909 # 5910 # } 5911 # 5912 # } 5913 # } 5914 # Response: 5915 # { 5916 # 5917 # "data": { 5918 # 5919 # "openIdProviders": { 5920 # 5921 # "records": [] 5922 # 5923 # } 5924 # 5925 # } 5926 # } 5927 # 5928 # Arguments 5929 # orgId: Filter Providers by organizationId. This is only used by 5930 # superadmin. 5931 # If filter with org-admin role, orgId is always the current user org. 5932 ( 5933 ID], : [ 5934 Boolean, : 5935 ID, : 5936 Int, : 5937 Int : 5938 ): OpenIdProviderList 5939 5940 # Arguments 5941 # orgId: This returns all packages that the Organization has 5942 # access to. 5943 # 5944 # ___Note: for Super-Admin use only.___ 5945 # resourceId: This returns packages that have the provided 5946 # resource linked to it 5947 # resourceAlias: This returns any packages have resources that 5948 # have the alias. 5949 # primaryResourceId: This returns packages that have the provided 5950 # resource as its primary resource 5951 # sourceOriginId: This returns the entire lineage of packages 5952 # that share the same sourceOriginId. 5953 # 5954 # This UUID is used to track a package's lineage. This UUID and versions is NOT 5955 # guaranteed to be a package ID and should not be used as such. 5956 # sourcePackageId: This returns any packages that immediately 5957 # derive from the provided ID. 5958 # 5959 # The sourcePackageId of a package refers to the package that it derived from, if 5960 # any. 5961 # For example, there is a lineage of packages that contain versions 1.0, 2.0, 3.0, 5962 # and 4.0. 5963 # If the ID of version 2.0 is provided, this filter will return the package 5964 # information for 5965 # only version 3.0. This is because version 3.0 is the immediate descendent of 5966 # version 2.0. 5967 # packageFilter: Fields to filter the results by. 5968 # distributionType: This returns packages of a specific 5969 # distribution type 5970 # status: This returns packages with a specific status 5971 # nameRegexp: name regexp pattern 5972 # owned: If true, return only packages owned by the calling org. 5973 # 5974 # If false, return all packages that the calling org has access to. 5975 # 5976 # The default behavior when `owned` is not provided assumes `false`. 5977 # 5978 # __Note__: Superadmin tokens are authorized to change the `orgId` field. If 5979 # provided, the above behavior will apply to `orgId` instead of the calling org. 5980 # includeDeleted: If true, result includes deleted packages 5981 # offset: Provide an offset to skip to a certain element in the 5982 # result, for paging. 5983 # limit: Specify maximum number of results to retrieve in this 5984 # result. Page size. 5985 ( 5986 ID, : 5987 ID, : 5988 ID, : 5989 String, : 5990 ID, : 5991 ID, : 5992 ID, : 5993 PackageFilter, : 5994 EngineDistributionType, : 5995 PackageStatus, : 5996 String, : 5997 Boolean, : 5998 Boolean, : 5999 Int, : 6000 Int : 6001 ): PackageList 6002 6003 # List existing package grants. 6004 # Either packageId or organizationId must be specified. 6005 # 6006 # The following examples assume that the caller is the owner of the Packages: 6007 # packageGrants(id: 123) - Show Grants for Package 123 6008 # packageGrants(organizationId: 12) - Show Grants for all Packages to Org 12 6009 # packageGrants(id: 123, organizationId: 12) Show Grants for Package 123 to Org 12 6010 # 6011 # Arguments 6012 # id: Package ID. If specified, show all the Grants for this 6013 # Package. 6014 # 6015 # If calling Org is owner of the Package, show all Grants. 6016 # 6017 # If calling Org is not owner of the Package, only show Grants for the Package to 6018 # the calling Org. 6019 # 6020 # If Super-Admin, show all Grants for the Package. 6021 # orgId: Show all Grants to the specified Org. 6022 # 6023 # If the input organizationId is different from the calling Org, this will show 6024 # Grants for Packages 6025 # that are owned by the calling Org to the specified Org. 6026 # 6027 # If the input organizationId is the same as the caller's Org, this will show 6028 # Grants for Packages 6029 # to the calling Org. 6030 # 6031 # If Super-Admin, show Grants for all Packages to the specified Org. 6032 # includeDeleted: If true, result includes deleted packages 6033 # offset: Provide an offset to skip to a certain element in the 6034 # result, for paging. 6035 # limit: Specify maximum number of results to retrieve in this 6036 # result. Page size. 6037 ( 6038 ID, : 6039 ID, : 6040 Boolean, : 6041 Int, : 6042 Int, : 6043 PackageGrantFilter : 6044 ): PackageGrantList 6045 6046 # Retrieve the basic user information. 6047 # The caller and the queried user are required to be members of the same 6048 # organization, 6049 # unless the caller is superadmin user. 6050 # Example: 6051 # Request: 6052 # query { 6053 # 6054 # basicUserInfo(id: "267de7e1-efb2-444a-a524-210328b78503") { 6055 # 6056 # id 6057 # 6058 # name 6059 # 6060 # firstName 6061 # 6062 # lastName 6063 # 6064 # email 6065 # 6066 # imageUrl 6067 # 6068 # } 6069 # } 6070 # Response: 6071 # { 6072 # 6073 # "data": { 6074 # 6075 # "basicUserInfo": { 6076 # 6077 # "id": "267de7e1-efb2-444a-a524-210328b78503", 6078 # 6079 # "name": "username", 6080 # 6081 # "firstName": "first", 6082 # 6083 # "lastName": "last", 6084 # 6085 # "email": "email@test.com", 6086 # 6087 # "imageUrl": null 6088 # 6089 # } 6090 # 6091 # } 6092 # } 6093 # 6094 # Arguments 6095 # id: The user ID. 6096 # A user ID is a string in UUID format. 6097 ID!): BasicUserInfo ( : 6098 6099 ApiTokenInfo]! : [ 6100 6101 # Gets the most up to date package linked to this automate flow 6102 # 6103 # Arguments 6104 # engineId: Engine Id for the automate flow. 6105 ID!): Package ( : 6106 6107 # Retrieve applicationViewers 6108 # Example: 6109 # Request: 6110 # query { 6111 # applicationViewers(limit:2) { 6112 # records{ 6113 # id 6114 # name 6115 # } 6116 # } 6117 # } 6118 # Response: 6119 # { 6120 # "data": { 6121 # "viewers": { 6122 # "records": [ 6123 # { 6124 # "id": "2a1a1b58-6983-4002-b9ed-7b7f325f621a", 6125 # "name": "Viewer 1" 6126 # }, 6127 # { 6128 # "id": "4a2a1b58-6993-4002-b9ed-7b7f325f662c", 6129 # "name": "Viewer 2" 6130 # } 6131 # ] 6132 # } 6133 # } 6134 # } 6135 # 6136 # Arguments 6137 # ids: Provide an ids to retrieve specific viewers. 6138 # offset: Specify maximum number of results to retrieve in this 6139 # result. Page size. 6140 # limit: Specify maximum number of results to retrieve in this 6141 # result. 6142 # orderBy: Provide a list of ApplicationViewerSortField to sort 6143 # by. 6144 ( 6145 ID!], : [ 6146 Int, : 6147 Int, : 6148 ApplicationViewerSortField : 6149 ): ApplicationViewerList 6150 6151 }
link Required by
This element is not required by anyone