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://support.veritone.com/s/article/000003943 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 all login configurations for the Instance 1572 # Example: 1573 # Request: 1574 # query { 1575 # 1576 # instanceLoginConfigurations { 1577 # 1578 # records { 1579 # 1580 # slug 1581 # 1582 # } 1583 # 1584 # } 1585 # } 1586 # Response: 1587 # { 1588 # 1589 # "data": { 1590 # 1591 # "instanceLoginConfigurations": { 1592 # 1593 # records: [ 1594 # 1595 # { 1596 # 1597 # "slug": "instance-slug", 1598 # 1599 # }, 1600 # 1601 # { 1602 # 1603 # "slug": "other-instance-slug", 1604 # 1605 # } 1606 # 1607 # ] 1608 # 1609 # } 1610 # 1611 # } 1612 # } 1613 # 1614 # Arguments 1615 # offset: Provide an offset to skip to a certain element in the 1616 # result, for paging. 1617 # limit: Specify maximum number of results to retrieve in this 1618 # result. Page size. 1619 Int, : Int): LoginConfigurationList ( : 1620 1621 # Retrieve a single registration configuration 1622 # 1623 # Example: 1624 # Request: 1625 # query { 1626 # 1627 # registrationConfiguration(id: "12345") { 1628 # 1629 # slug 1630 # 1631 # } 1632 # } 1633 # Response: 1634 # { 1635 # 1636 # "data": { 1637 # 1638 # "registrationConfiguration": { 1639 # 1640 # "slug": "test" 1641 # 1642 # } 1643 # 1644 # } 1645 # } 1646 # 1647 # Arguments 1648 # id: The registration configuration ID 1649 ID!): RegistrationConfiguration ( : 1650 1651 # Retrieve a registration configuration info by slug 1652 # 1653 # Example: 1654 # Request: 1655 # query { 1656 # 1657 # registrationConfigurationInfo(slug: "test") { 1658 # 1659 # id 1660 # 1661 # } 1662 # } 1663 # Response: 1664 # { 1665 # 1666 # "data": { 1667 # 1668 # "registrationConfigurationInfo": { 1669 # 1670 # "id": "12345" 1671 # 1672 # } 1673 # 1674 # } 1675 # } 1676 # 1677 # Arguments 1678 # slug: The registration configuration ID 1679 String!): RegistrationConfigurationInfo ( : 1680 1681 # Retrieve permissions 1682 # Example: 1683 # Request: 1684 # query { 1685 # 1686 # permissions(limit:5) { 1687 # 1688 # records { 1689 # 1690 # id 1691 # 1692 # name 1693 # 1694 # } 1695 # 1696 # } 1697 # } 1698 # 1699 # Response: 1700 # { 1701 # 1702 # "data": { 1703 # 1704 # "permissions": { 1705 # 1706 # "records": [ 1707 # 1708 # { 1709 # 1710 # "id": "2", 1711 # 1712 # "name": "admin.access" 1713 # 1714 # }, 1715 # 1716 # { 1717 # 1718 # "id": "9", 1719 # 1720 # "name": "admin.group.create" 1721 # 1722 # }, 1723 # 1724 # { 1725 # 1726 # "id": "12", 1727 # 1728 # "name": "admin.group.delete" 1729 # 1730 # }, 1731 # 1732 # { 1733 # 1734 # "id": "10", 1735 # 1736 # "name": "admin.group.read" 1737 # 1738 # }, 1739 # 1740 # { 1741 # 1742 # "id": "11", 1743 # 1744 # "name": "admin.group.update" 1745 # 1746 # } 1747 # 1748 # ] 1749 # 1750 # } 1751 # 1752 # } 1753 # } 1754 # 1755 # Arguments 1756 # id: Provide an ID to retrieve a single specific permission. 1757 # offset: Provide an offset to skip to a certain element in the 1758 # result, for paging. 1759 # limit: Specify maximum number of results to retrieve in this 1760 # result. Page size. 1761 ID, : String, : Int, : Int): PermissionList ( : 1762 1763 # Retrieve users 1764 # Example: 1765 # Request: 1766 # query { 1767 # 1768 # users( 1769 # 1770 # organizationIds:"35521", 1771 # 1772 # limit: 2) { 1773 # 1774 # records { 1775 # 1776 # id 1777 # 1778 # name 1779 # 1780 # } 1781 # 1782 # } 1783 # } 1784 # Response: 1785 # { 1786 # 1787 # "data": { 1788 # 1789 # "users": { 1790 # 1791 # "records": [ 1792 # 1793 # { 1794 # 1795 # "id": "267de7e1-efb2-444a-a524-210328b78503", 1796 # 1797 # "name": "example" 1798 # 1799 # }, 1800 # 1801 # { 1802 # 1803 # "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066", 1804 # 1805 # "name": "example1" 1806 # 1807 # } 1808 # 1809 # ] 1810 # 1811 # } 1812 # 1813 # } 1814 # } 1815 # 1816 # Arguments 1817 # id: Provide an ID to retrieve a single specific user. 1818 # A user ID is a string in UUID format. 1819 # ids: Provide IDs to retrieve multiple users by ID. 1820 # name: Provide a name, or part of one, to search by name. 1821 # organizationIds: Provide a list of organization IDs to filter 1822 # your search by organization. 1823 # offset: Provide an offset to skip to a certain element in the 1824 # result, for paging. 1825 # limit: Specify maximum number of results to retrieve in this 1826 # result. Page size. 1827 # includeAllOrgUsers: Include all organization users. 1828 # dateTimeFilter: Filter by date/time field 1829 # status: Filter by account status 1830 # statuses: Filter by account status list. Status field will take 1831 # precedence if used 1832 # roleIds: Filter by application roles 1833 ( 1834 ID, : 1835 ID], : [ 1836 String, : 1837 ID], : [ 1838 Int, : 1839 Int, : 1840 Boolean, : 1841 UsersDateTimeFilter!], : [ 1842 UserStatus, : 1843 UserStatus!], : [ 1844 ID] : [ 1845 ): UserList 1846 1847 # Retrieve an individual user 1848 # Example: 1849 # Request: 1850 # query { 1851 # 1852 # user(id: "267de7e1-efb2-444a-a524-210328b78503") { 1853 # 1854 # name 1855 # 1856 # status 1857 # 1858 # } 1859 # } 1860 # Response: 1861 # { 1862 # 1863 # "data": { 1864 # 1865 # "user": { 1866 # 1867 # "name": "example", 1868 # 1869 # "status": "deleted" 1870 # 1871 # } 1872 # 1873 # } 1874 # } 1875 # 1876 # Arguments 1877 # id: The user ID. 1878 # A user ID is a string in UUID format. 1879 ID!, : [ID]): User ( : 1880 1881 # Retrieve user's organization API tokens 1882 # Example: 1883 # Request: 1884 # query { 1885 # 1886 # tokens { 1887 # 1888 # id 1889 # 1890 # applicationId 1891 # 1892 # } 1893 # } 1894 # Response: 1895 # { 1896 # 1897 # "data": { 1898 # 1899 # "tokens": [] 1900 # 1901 # } 1902 # } 1903 Token] : [ 1904 1905 # Retrieve information for the current logged-in user 1906 # Example: 1907 # Request: 1908 # query { 1909 # 1910 # me { 1911 # 1912 # id 1913 # 1914 # organizationId 1915 # 1916 # } 1917 # } 1918 # Response: 1919 # { 1920 # 1921 # "data": { 1922 # 1923 # "me": { 1924 # 1925 # "id": "59cb4e74-7c31-4267-b91e-d4600bc08008", 1926 # 1927 # "organizationId": "35521" 1928 # 1929 # } 1930 # 1931 # } 1932 # } 1933 User : 1934 1935 # Retrieve groups 1936 # Example: 1937 # Request: 1938 # query { 1939 # 1940 # groups { 1941 # 1942 # records { 1943 # 1944 # id 1945 # 1946 # name 1947 # 1948 # } 1949 # 1950 # } 1951 # } 1952 # Response: 1953 # { 1954 # 1955 # "data": { 1956 # 1957 # "groups": { 1958 # 1959 # "records": [ 1960 # 1961 # { 1962 # 1963 # "id": "8db639c1-c926-4f83-90de-d86c2ae5973d", 1964 # 1965 # "name": "WTS API Docs Org" 1966 # 1967 # } 1968 # 1969 # ] 1970 # 1971 # } 1972 # 1973 # } 1974 # } 1975 # 1976 # Arguments 1977 # id: Provide an ID to retrieve a specific group by ID 1978 # ids: Provide IDs to retrieve multiple groups by ID 1979 # name: Provide a name, or part of one, to search for groups by 1980 # name 1981 # organizationIds: " 1982 # Provide a list of organization IDs to retrieve groups defined 1983 # within certain organizations. 1984 # offset: Provide an offset to skip to a certain element in the 1985 # result, for paging. 1986 # limit: Specify maximum number of results to retrieve in this 1987 # result. Page size. 1988 ID, : [ID], : String, : [ID], : Int, : Int): GroupList ( : 1989 1990 # Retrieve a single mention 1991 # 1992 # Arguments 1993 # mentionId: The mention ID 1994 # limit: Comments pagination - limit 1995 # offset: Comments pagination - limit 1996 # userId: The user who owns the mention. 1997 ID!, : Int, : Int, : String): Mention ( : 1998 1999 # Retrieve a shared mention 2000 # 2001 # Arguments 2002 # shareId: share token 2003 ID!): SharedMention ( : 2004 2005 # Search for mentions across an index. 2006 # This query requires a user token. 2007 # Known Issues: 2008 # - Offset can not go past 10,000. To get around this, the best practice is to 2009 # keep updating the start time of the query based on the last mention you have 2010 # processed. 2011 # Example: 2012 # Request: 2013 # query{ 2014 # 2015 # searchMentions(search:{ 2016 # 2017 # offset: 0 2018 # 2019 # limit: 1 2020 # 2021 # index: ["mine"] 2022 # 2023 # query:{ 2024 # 2025 # operator: "and" 2026 # 2027 # conditions: [{ 2028 # 2029 # operator: "term" 2030 # 2031 # field: "trackingUnitName" 2032 # 2033 # value: "Dallas Cowboys Super Bowl" 2034 # 2035 # }, 2036 # 2037 # { 2038 # 2039 # operator: "term" 2040 # 2041 # field: "mentionStatusId" 2042 # 2043 # value: "1" 2044 # 2045 # }] 2046 # 2047 # } 2048 # 2049 # }) { 2050 # 2051 # jsondata 2052 # 2053 # } 2054 # } 2055 # Response: 2056 # { 2057 # 2058 # "data": { 2059 # 2060 # "searchMentions": { 2061 # 2062 # "jsondata": { 2063 # 2064 # "results": [ 2065 # 2066 # { 2067 # 2068 # "id": 47569938, 2069 # 2070 # "programFormatName": "Information and News", 2071 # 2072 # "mentionDate": "2017-01-31T07:59:18.000Z", 2073 # 2074 # "mediaStartTime": "2017-01-31T07:45:01.000Z", 2075 # 2076 # "mediaId": 20017455, 2077 # 2078 # "metadata": { 2079 # 2080 # "filename": "AM-RADIO", 2081 # 2082 # "veritone-file": { 2083 # 2084 # "size": 0, 2085 # 2086 # "filename": "AM-RADIO", 2087 # 2088 # "mimetype": "audio/mpeg" 2089 # 2090 # }, 2091 # 2092 # "veritone-media-source": { 2093 # 2094 # "mediaSourceId": "14326", 2095 # 2096 # "mediaSourceTypeId": "1" 2097 # 2098 # }, 2099 # 2100 # "veritone-program": { 2101 # 2102 # "programId": "3828", 2103 # 2104 # "programName": "AM-RADIO Morning Talk", 2105 # 2106 # "programImage": 2107 # "https://s3.amazonaws.com/prod-veritone-ugc/cb5e59d4-a986-4e2b-b525-482319df3350%2FbrdProgram%2F2uGsLVKsQeiKN3UuHufC_941478_10151455644772706_951533539_n.jpg", 2108 # 2109 # "programLiveImage": 2110 # "https://s3.amazonaws.com/prod-veritone-ugc/cb5e59d4-a986-4e2b-b525-482319df3350%2FbrdProgram%2FwwEn3Ya9RgmMQwUEGoD1_LUkKlgZQS36ncUbY8Iz7_2520to%2520live2.JPG" 2111 # 2112 # } 2113 # 2114 # }, 2115 # 2116 # "fileLocation": 2117 # "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", 2118 # 2119 # "fileType": "audio/mpeg", 2120 # 2121 # "snippets": [ 2122 # 2123 # { 2124 # 2125 # "startTime": 857.62, 2126 # 2127 # "endTime": 887.33, 2128 # 2129 # "text": "eighty first women's Australian Open final Monica Seles beat Steffi 2130 # Graf four six six three six two in one thousand nine hundred twenty eight the 2131 # Dallas Cowboys beat the Buffalo Bills thirty to thirteen in Atlanta running back 2132 # Emmitt Smith wins the M.V.P. and fourth consecutive Super Bowl game loss to the 2133 # Cowboys twenty sixteen at the one hundred fourth women's Australian Open final 2134 # six three six six four that time capsule your", 2135 # 2136 # "hits": [ 2137 # 2138 # { 2139 # 2140 # "startTime": 865.7, 2141 # 2142 # "endTime": 865.929, 2143 # 2144 # "queryTerm": "Dallas" 2145 # 2146 # }, 2147 # 2148 # { 2149 # 2150 # "startTime": 865.93, 2151 # 2152 # "endTime": 866.07, 2153 # 2154 # "queryTerm": "Cowboys" 2155 # 2156 # }, 2157 # 2158 # { 2159 # 2160 # "startTime": 872.74, 2161 # 2162 # "endTime": 873.31, 2163 # 2164 # "queryTerm": "Super" 2165 # 2166 # }, 2167 # 2168 # { 2169 # 2170 # "startTime": 873.31, 2171 # 2172 # "endTime": 873.43, 2173 # 2174 # "queryTerm": "Bowl" 2175 # 2176 # } 2177 # 2178 # ] 2179 # 2180 # } 2181 # 2182 # ], 2183 # 2184 # "userSnippets": null, 2185 # 2186 # "advertiserId": 0, 2187 # 2188 # "advertiserName": "", 2189 # 2190 # "brandId": 0, 2191 # 2192 # "brandImage": "", 2193 # 2194 # "brandName": "", 2195 # 2196 # "campaignId": 0, 2197 # 2198 # "campaignName": "", 2199 # 2200 # "organizationId": 7295, 2201 # 2202 # "organizationName": "Demo Organization", 2203 # 2204 # "trackingUnitId": 10032, 2205 # 2206 # "trackingUnitName": "Dallas Cowboys Super Bowl", 2207 # 2208 # "mentionStatusId": 1, 2209 # 2210 # "mediaSourceTypeId": 1, 2211 # 2212 # "mediaSourceTypeName": "Audio", 2213 # 2214 # "mediaSourceId": 14326, 2215 # 2216 # "mediaSourceName": "AM-RADIO Morning Talk", 2217 # 2218 # "isNational": true, 2219 # 2220 # "spotTypeId": null, 2221 # 2222 # "spotTypeName": null, 2223 # 2224 # "programId": 3828, 2225 # 2226 # "programName": "AM-RADIO", 2227 # 2228 # "programImage": 2229 # "https://s3.amazonaws.com/prod-veritone-ugc/cb5e59d4-a986-4e2b-b525-482319df3350%2FbrdProgram%2F2uGsLVKsQeiKN3UuHufC_941478_10151455644772706_951533539_n.jpg", 2230 # 2231 # "programLiveImage": 2232 # "https://s3.amazonaws.com/prod-veritone-ugc/cb5e52b4-a986-4e2b-b525-482319df3350%2FbrdProgram%2FwwEn3Ya9RgmMQwUEGoD1_LUkKlgZQS36ncUbY8Iz7_2520to%2520live2.JPG", 2233 # 2234 # "impressions": 1894, 2235 # 2236 # "audience": [ 2237 # 2238 # { 2239 # 2240 # "gender": "men", 2241 # 2242 # "age_group": "35-44", 2243 # 2244 # "audience": 11, 2245 # 2246 # "isTargetMatch": true 2247 # 2248 # }, 2249 # 2250 # { 2251 # 2252 # "gender": "men", 2253 # 2254 # "age_group": "45-49", 2255 # 2256 # "audience": 121, 2257 # 2258 # "isTargetMatch": true 2259 # 2260 # }, 2261 # 2262 # { 2263 # 2264 # "gender": "men", 2265 # 2266 # "age_group": "50-54", 2267 # 2268 # "audience": 474, 2269 # 2270 # "isTargetMatch": true 2271 # 2272 # }, 2273 # 2274 # { 2275 # 2276 # "gender": "men", 2277 # 2278 # "age_group": "65+", 2279 # 2280 # "audience": 95, 2281 # 2282 # "isTargetMatch": true 2283 # 2284 # }, 2285 # 2286 # { 2287 # 2288 # "gender": "women", 2289 # 2290 # "age_group": "50-54", 2291 # 2292 # "audience": 19, 2293 # 2294 # "isTargetMatch": false 2295 # 2296 # }, 2297 # 2298 # { 2299 # 2300 # "gender": "women", 2301 # 2302 # "age_group": "65+", 2303 # 2304 # "audience": 693, 2305 # 2306 # "isTargetMatch": false 2307 # 2308 # }, 2309 # 2310 # { 2311 # 2312 # "gender": "men", 2313 # 2314 # "age_group": "55-64", 2315 # 2316 # "audience": 481, 2317 # 2318 # "isTargetMatch": true 2319 # 2320 # } 2321 # 2322 # ], 2323 # 2324 # "targetAudience": { 2325 # 2326 # "gender": 1, 2327 # 2328 # "genderName": "M", 2329 # 2330 # "ageGroup": [ 2331 # 2332 # 0, 2333 # 2334 # 5 2335 # 2336 # ], 2337 # 2338 # "ageGroupMin": 18, 2339 # 2340 # "ageGroupMax": 0, 2341 # 2342 # "impressions": 1182 2343 # 2344 # }, 2345 # 2346 # "audienceMarketCount": 3, 2347 # 2348 # "audienceAffiliateCount": 1, 2349 # 2350 # "rating": null, 2351 # 2352 # "ratings": null, 2353 # 2354 # "comments": null, 2355 # 2356 # "markets": [ 2357 # 2358 # { 2359 # 2360 # "marketId": 54, 2361 # 2362 # "marketName": "Des Moines-Ames, IA" 2363 # 2364 # } 2365 # 2366 # ], 2367 # 2368 # "marketId": null, 2369 # 2370 # "marketName": null, 2371 # 2372 # "hourOfDay": 7, 2373 # 2374 # "dayOfWeek": 2, 2375 # 2376 # "dayOfMonth": 31, 2377 # 2378 # "month": 1, 2379 # 2380 # "year": 2017, 2381 # 2382 # "isMatch": true, 2383 # 2384 # "mentionStatusName": "Pending Verification", 2385 # 2386 # "complianceStatusId": null, 2387 # 2388 # "cognitiveEngineResults": null, 2389 # 2390 # "hits": 4 2391 # 2392 # } 2393 # 2394 # ], 2395 # 2396 # "totalResults": 579, 2397 # 2398 # "limit": 1, 2399 # 2400 # "from": 0, 2401 # 2402 # "to": 0, 2403 # 2404 # "searchToken": "ae882400-e1d9-11e7-947b-339cddca931e", 2405 # 2406 # "timestamp": 1513371071 2407 # 2408 # } 2409 # 2410 # } 2411 # 2412 # } 2413 # } 2414 # 2415 # Arguments 2416 # search: JSON structure containing the search query. 2417 # See https://docs.veritone.com/#/apis/search-quickstart for full details on the 2418 # search query syntax 2419 JSONData!): SearchResult ( : 2420 2421 # Search for media across an index. 2422 # This query requires a user token. 2423 # Example: 2424 # Request: 2425 # query{ 2426 # 2427 # searchMedia(search:{ 2428 # 2429 # offset: 0 2430 # 2431 # limit: 1 2432 # 2433 # index: ["mine"] 2434 # 2435 # query:{ 2436 # 2437 # operator: "query_string" 2438 # 2439 # field: "transcript.transcript" 2440 # 2441 # value: "paris NOT \"las vegas\"" 2442 # 2443 # } 2444 # 2445 # }) { 2446 # 2447 # jsondata 2448 # 2449 # } 2450 # } 2451 # Response: 2452 # { 2453 # 2454 # "data": { 2455 # 2456 # "searchMedia": { 2457 # 2458 # "jsondata": { 2459 # 2460 # "results": [ 2461 # 2462 # { 2463 # 2464 # "recording": { 2465 # 2466 # "recordingId": "43033727", 2467 # 2468 # "fileLocation": 2469 # "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", 2470 # 2471 # "fileType": "video/mp4", 2472 # 2473 # "programId": "-1", 2474 # 2475 # "programName": "Weekly Talkshow", 2476 # 2477 # "programLiveImage": 2478 # "https://inspirent.s3.amazonaws.com/assets/43033727/fe693b30-18ae-47c7-984f-530eab61d7.jpeg", 2479 # 2480 # "mediaSourceId": "-1", 2481 # 2482 # "mediaSourceTypeId": "5", 2483 # 2484 # "sliceTime": 1512682022, 2485 # 2486 # "mediaStartTime": 1512681992, 2487 # 2488 # "aibDuration": 90, 2489 # 2490 # "isOwn": true, 2491 # 2492 # "hitStartTime": 1512682022, 2493 # 2494 # "hitEndTime": 1512682082 2495 # 2496 # }, 2497 # 2498 # "startDateTime": 1512682022, 2499 # 2500 # "stopDateTime": 1512682082, 2501 # 2502 # "hits": [ 2503 # 2504 # { 2505 # 2506 # "veritone-file": { 2507 # 2508 # "filename": "Veritone_v06.mp4", 2509 # 2510 # "mimetype": "video/mp4", 2511 # 2512 # "size": 162533502 2513 # 2514 # } 2515 # 2516 # } 2517 # 2518 # ] 2519 # 2520 # } 2521 # 2522 # ], 2523 # 2524 # "totalResults": 733275, 2525 # 2526 # "limit": 1, 2527 # 2528 # "from": 0, 2529 # 2530 # "to": 0, 2531 # 2532 # "searchToken": "930f0960-e1c3-11e7-9e94-eba5f6b5faf7", 2533 # 2534 # "timestamp": 1513361576 2535 # 2536 # } 2537 # 2538 # } 2539 # 2540 # } 2541 # } 2542 # 2543 # Arguments 2544 # search: JSON structure containing the search query. 2545 # See https://docs.veritone.com/#/apis/search-quickstart for full details on the 2546 # search query syntax 2547 JSONData!): SearchResult ( : 2548 2549 # Retrieve the root folders for an organization 2550 # Example: 2551 # Request: 2552 # query { 2553 # 2554 # rootFolders { 2555 # 2556 # id 2557 # 2558 # typeId 2559 # 2560 # } 2561 # } 2562 # Response: 2563 # { 2564 # 2565 # "data": { 2566 # 2567 # "rootFolders": [ 2568 # 2569 # { 2570 # 2571 # "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982", 2572 # 2573 # "typeId": 4 2574 # 2575 # }, 2576 # 2577 # { 2578 # 2579 # "id": "d3e27eb3-7d4a-47ab-af64-bf1529390f4e", 2580 # 2581 # "typeId": 4 2582 # 2583 # } 2584 # 2585 # ] 2586 # 2587 # } 2588 # } 2589 # 2590 # Arguments 2591 # type: The type of root folder to retrieve 2592 RootFolderType): [Folder] ( : 2593 2594 # Retrieve a single folder. Used to navigate the folder tree structure. 2595 # Example: 2596 # Request: 2597 # query { 2598 # 2599 # folder(id: "2ac28573-917a-4c4b-be91-a0ac64cbc982") { 2600 # 2601 # typeId 2602 # 2603 # id 2604 # 2605 # childFolders{ 2606 # 2607 # records{ 2608 # 2609 # id 2610 # 2611 # } 2612 # 2613 # } 2614 # 2615 # } 2616 # } 2617 # Response: 2618 # { 2619 # 2620 # "data": { 2621 # 2622 # "folder": { 2623 # 2624 # "typeId": 4, 2625 # 2626 # "id": "3104f61f-4bd1-4175-9fe6-27436d591c54", 2627 # 2628 # "childFolders": { 2629 # 2630 # "records": [ 2631 # 2632 # { 2633 # 2634 # "id": "9d639f1b-a0d4-47b0-8149-3568f048f320" 2635 # 2636 # }, 2637 # 2638 # { 2639 # 2640 # "id": "a347319d-72da-43a2-93fc-e677876aca80" 2641 # 2642 # } 2643 # 2644 # ] 2645 # 2646 # } 2647 # 2648 # } 2649 # 2650 # } 2651 # } 2652 # 2653 # Arguments 2654 # id: Provide an ID to retrieve a single specific user. 2655 ID!): Folder ( : 2656 2657 # Retrieve the current platform information. 2658 # Example: 2659 # Request: 2660 # query { 2661 # 2662 # platformInfo { 2663 # 2664 # properties 2665 # 2666 # aiWAREVersion { 2667 # 2668 # currentVersion { 2669 # 2670 # version 2671 # 2672 # } 2673 # 2674 # previousVersion { 2675 # 2676 # version 2677 # 2678 # } 2679 # 2680 # nextVersion { 2681 # 2682 # version 2683 # 2684 # } 2685 # 2686 # } 2687 # 2688 # aiWAREVersionHistory(offset: 0, limit: 30) { 2689 # 2690 # platformVersion { 2691 # 2692 # id 2693 # 2694 # version 2695 # 2696 # } 2697 # 2698 # id 2699 # 2700 # }, 2701 # 2702 # aiWAREVersionList (orderBy: version, orderDirection: desc) { 2703 # 2704 # count 2705 # 2706 # records { 2707 # 2708 # id 2709 # 2710 # version 2711 # 2712 # } 2713 # 2714 # } 2715 # 2716 # } 2717 # } 2718 # Response: 2719 # { 2720 # 2721 # "data": { 2722 # 2723 # "platformInfo": { 2724 # 2725 # "properties": { 2726 # 2727 # "Environment": "US West", 2728 # 2729 # "ClusterSize": "small" 2730 # 2731 # } 2732 # 2733 # "aiWAREVersion": { 2734 # 2735 # "currentVersion": { 2736 # 2737 # "version": "1.1.0" 2738 # 2739 # }, 2740 # 2741 # "previousVersion": { 2742 # 2743 # "version": "1.0.0" 2744 # 2745 # }, 2746 # 2747 # "nextVersion": { 2748 # 2749 # "version": "1.2.0" 2750 # 2751 # } 2752 # 2753 # }, 2754 # 2755 # "aiWAREVersionHistory": [ 2756 # 2757 # { 2758 # 2759 # platformVersion: 2760 # 2761 # { 2762 # 2763 # "id": "c7a91281-6a1e-46d4-9f2c-7f8b4a1fc493", 2764 # 2765 # "version": "1.3.0" 2766 # 2767 # }, 2768 # 2769 # "id": "30c9c2a2-ae6a-4be2-b80c-6893d8b56780" 2770 # 2771 # }, 2772 # 2773 # { 2774 # 2775 # platformVersion: 2776 # 2777 # { 2778 # 2779 # "id": "f785bc56-2d43-472e-8629-99f9b9a5c57e", 2780 # 2781 # "version": "1.3.0" 2782 # 2783 # }, 2784 # 2785 # "id": "7b8a2ab2-00de-4f1b-9fb1-99e7a9cd108f" 2786 # 2787 # }, 2788 # 2789 # { 2790 # 2791 # platformVersion: 2792 # 2793 # { 2794 # 2795 # "id": "3c4c0b46-1a61-45ab-9f3e-b8f7a14bfaa7", 2796 # 2797 # "version": "1.3.0" 2798 # 2799 # }, 2800 # 2801 # "id": "d3499a78-efc7-4a72-a12d-852f53231e33" 2802 # 2803 # } 2804 # 2805 # ], 2806 # 2807 # "aiWAREVersionList": { 2808 # 2809 # "count": 3, 2810 # 2811 # "records": [ 2812 # 2813 # { 2814 # 2815 # "id": "799150bb-8d67-4cd1-b204-d9346e012588", 2816 # 2817 # "version": "1.0.11" 2818 # 2819 # }, 2820 # 2821 # { 2822 # 2823 # "id": "2892e80d-e0bf-4ffc-be17-4bb173d6ad29", 2824 # 2825 # "version": "1.0.2" 2826 # 2827 # }, 2828 # 2829 # { 2830 # 2831 # "id": "095b9558-6fc1-4775-9696-082b9f098c47", 2832 # 2833 # "version": "1.0.1" 2834 # 2835 # }, 2836 # 2837 # ] 2838 # 2839 # } 2840 # 2841 # } 2842 # 2843 # } 2844 # } 2845 PlatformInfo! : 2846 2847 # Example: 2848 # Request: 2849 # query { 2850 # 2851 # auditEvents(limit: 2) { 2852 # 2853 # records { 2854 # 2855 # id 2856 # 2857 # application 2858 # 2859 # } 2860 # 2861 # } 2862 # } 2863 # Response: 2864 # { 2865 # 2866 # "data": { 2867 # 2868 # "auditEvents": { 2869 # 2870 # "records": [ 2871 # 2872 # { 2873 # 2874 # "id": "fdc7b3a3-ab23-4866-a330-c0ad910cd64f", 2875 # 2876 # "application": "" 2877 # 2878 # } 2879 # 2880 # ] 2881 # 2882 # } 2883 # 2884 # } 2885 # } 2886 # 2887 # Arguments 2888 # query: An elastic query for audit events 2889 # application: Filter logs by a specific application 2890 # terms: Term filters to filter documents by properties in the 2891 # payload 2892 ( 2893 JSONData, : 2894 OrderDirection, : 2895 String, : 2896 JSONData!], : [ 2897 Int, : 2898 Int : 2899 ): AuditEventList! 2900 2901 # Retrieve a folder overview 2902 # Example: 2903 # Request: 2904 # query { 2905 # 2906 # folderOverview(ids:"3104f61f-4bd1-4175-9fe6-27436d591c54") { 2907 # 2908 # childFoldersCount 2909 # 2910 # childNonFolderObjectsCount 2911 # 2912 # } 2913 # } 2914 # Response: 2915 # { 2916 # 2917 # "data": { 2918 # 2919 # "folderOverview": { 2920 # 2921 # "childFoldersCount": 3, 2922 # 2923 # "childNonFolderObjectsCount": 0 2924 # 2925 # } 2926 # 2927 # } 2928 # } 2929 # 2930 # Arguments 2931 # ids: Tree Object Ids 2932 ID!]!, : RootFolderType): FolderOverview ( : [ 2933 2934 # Example: 2935 # Request: 2936 # query { 2937 # 2938 # folderSummaryDetails(ids: "3104f61f-4bd1-4175-9fe6-27436d591c54") { 2939 # 2940 # id 2941 # 2942 # typeId 2943 # 2944 # } 2945 # } 2946 # Response: 2947 # { 2948 # 2949 # "data": { 2950 # 2951 # "folderSummaryDetails": [ 2952 # 2953 # { 2954 # 2955 # "id": "1580701928", 2956 # 2957 # "typeId": 5 2958 # 2959 # }, 2960 # 2961 # { 2962 # 2963 # "id": "1580388995", 2964 # 2965 # "typeId": 5 2966 # 2967 # }, 2968 # 2969 # { 2970 # 2971 # "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982", 2972 # 2973 # "typeId": 4 2974 # 2975 # }, 2976 # 2977 # { 2978 # 2979 # "id": "243625", 2980 # 2981 # "typeId": 3 2982 # 2983 # }, 2984 # 2985 # { 2986 # 2987 # "id": "242599", 2988 # 2989 # "typeId": 3 2990 # 2991 # }, 2992 # 2993 # { 2994 # 2995 # "id": "d551fbd6-7354-4b0e-abfb-654ab8583be2", 2996 # 2997 # "typeId": 1 2998 # 2999 # }, 3000 # 3001 # { 3002 # 3003 # "id": "a347319d-72da-43a2-93fc-e677876aca80", 3004 # 3005 # "typeId": 1 3006 # 3007 # }, 3008 # 3009 # { 3010 # 3011 # "id": "9d639f1b-a0d4-47b0-8149-3568f048f320", 3012 # 3013 # "typeId": 1 3014 # 3015 # } 3016 # 3017 # ] 3018 # 3019 # } 3020 # } 3021 # 3022 # Arguments 3023 # ids: Tree Object Ids 3024 ( 3025 ID!]!, : [ 3026 RootFolderType : 3027 ): [FolderSummaryDetail] 3028 3029 # Retrieve configs for a given application 3030 # Example: 3031 # Request: 3032 # query { 3033 # 3034 # applicationConfig(applicationId: "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a") { 3035 # 3036 # records: { 3037 # 3038 # configType 3039 # 3040 # configLevel 3041 # 3042 # } 3043 # 3044 # offset: 0 3045 # 3046 # limit: 1 3047 # 3048 # } 3049 # } 3050 # Response: 3051 # { 3052 # 3053 # "data": { 3054 # 3055 # "applicationConfig": { 3056 # 3057 # "records": { 3058 # 3059 # "configType": "String", 3060 # 3061 # "configLevel": "Organization" 3062 # 3063 # } 3064 # 3065 # } 3066 # 3067 # } 3068 # } 3069 # 3070 # Arguments 3071 # orgId: Optional. Organization ID. 3072 # 3073 # If not specified, this will be the user's organization 3074 # userId: Optional. If specified, returned the configs for this 3075 # user and organization combo 3076 # includeDefaults: If true, include defaults not specified 3077 # configKeyRegexp: If specified, filter the configKey 3078 # offset: Specify maximum number of results to retrieve in this 3079 # result. Page size. 3080 # limit: Specify maximum number of results to retrieve in this 3081 # result. 3082 ( 3083 ID!, : 3084 ID, : 3085 ID, : 3086 Boolean, : 3087 String, : 3088 Int, : 3089 Int : 3090 ): ApplicationConfigList! 3091 3092 # Retrieve config definitions for a given application 3093 # Example: 3094 # Request: 3095 # query { 3096 # 3097 # applicationConfigDefinition(applicationId: 3098 # "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a", configKey: 'dark mode') { 3099 # 3100 # records: { 3101 # 3102 # configType 3103 # 3104 # defaultValue 3105 # 3106 # } 3107 # 3108 # offset: 0 3109 # 3110 # limit: 1 3111 # 3112 # } 3113 # } 3114 # Response: 3115 # { 3116 # 3117 # "data": { 3118 # 3119 # "applicationConfigDefinition": { 3120 # 3121 # "records": [{ 3122 # 3123 # "configType": Boolean, 3124 # 3125 # "defaultValue": true, 3126 # 3127 # }] 3128 # 3129 # } 3130 # 3131 # } 3132 # } 3133 # 3134 # Arguments 3135 # configKey: If specified, grab definition for this config key 3136 # offset: Specify maximum number of results to retrieve in this 3137 # result. Page size. 3138 # limit: Specify maximum number of results to retrieve in this 3139 # result. 3140 ( 3141 ID!, : 3142 String, : 3143 Int, : 3144 Int : 3145 ): ApplicationConfigDefinitionList! 3146 3147 # Retrieve a single application 3148 # Example: 3149 # Request: 3150 # query { 3151 # 3152 # application(id: "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a") { 3153 # 3154 # name 3155 # 3156 # key 3157 # 3158 # } 3159 # } 3160 # Response: 3161 # { 3162 # 3163 # "data": { 3164 # 3165 # "application": { 3166 # 3167 # "name": "appexamplebill", 3168 # 3169 # "key": "appexamplebill" 3170 # 3171 # } 3172 # 3173 # } 3174 # } 3175 # 3176 # Arguments 3177 # id: The application ID 3178 # excludeViewOnly: Only retrieve package grantType=VIEW when 3179 # explicitly enter false 3180 ID!, : Boolean): Application ( : 3181 3182 # Retrieve headerbar information for an application 3183 # Example: 3184 # Request: 3185 # query { 3186 # 3187 # applicationHeaderbar(id: "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a") { 3188 # 3189 # name 3190 # 3191 # config { 3192 # 3193 # title 3194 # 3195 # } 3196 # 3197 # } 3198 # } 3199 # Response: 3200 # { 3201 # 3202 # "data": { 3203 # 3204 # "applicationHeaderbar": { 3205 # 3206 # "name": "APP_BAR", 3207 # 3208 # "config": { 3209 # 3210 # "title": "Library" 3211 # 3212 # } 3213 # 3214 # } 3215 # 3216 # } 3217 # } 3218 # 3219 # Arguments 3220 # appId: The application ID 3221 # orgId: Optional organization ID. Normally this value is 3222 # computed by the server 3223 # based on the authorization token used for the request. 3224 ID!, : ID): ApplicationHeaderbar ( : 3225 3226 # Retrieve a list of schemas for structured data ingestions\ 3227 # Example: 3228 # Request: 3229 # query { 3230 # 3231 # schemas(limit: 2) { 3232 # 3233 # records { 3234 # 3235 # id 3236 # 3237 # organizationId 3238 # 3239 # } 3240 # 3241 # } 3242 # } 3243 # Response: 3244 # { 3245 # 3246 # "data": { 3247 # 3248 # "schemas": { 3249 # 3250 # "records": [ 3251 # 3252 # { 3253 # 3254 # "id": "21a08123-45dc-497e-b329-360d9f3fcaac", 3255 # 3256 # "organizationId": "35521" 3257 # 3258 # }, 3259 # 3260 # { 3261 # 3262 # "id": "57aa1618-344d-4d35-9980-5fe1ec6c3112", 3263 # 3264 # "organizationId": "35521" 3265 # 3266 # } 3267 # 3268 # ] 3269 # 3270 # } 3271 # 3272 # } 3273 # } 3274 # 3275 # Arguments 3276 # id: Id of a schema to retrieve 3277 # ids: Ids of schemas to retrieve 3278 # dataRegistryId: Specify the id of the DataRegistry to get 3279 # schemas 3280 # status: Specify one or more statuses to filter by schema status 3281 # majorVersion: Specify a major version to filter schemas 3282 # name: Specify a data registry name to filter schemas 3283 # nameMatch: The strategy used to find data registry name 3284 # accessScope: Specify one or more access scopes to filter by 3285 # accessible schemas 3286 # limit: Limit 3287 # offset: Offset 3288 # orderBy: Specify one or more fields and direction to order 3289 # results 3290 ( 3291 ID, : 3292 ID!], : [ 3293 ID, : 3294 SchemaStatus!], : [ 3295 Int, : 3296 String, : 3297 StringMatch, : 3298 AccessScope!], : [ 3299 Int, : 3300 Int, : 3301 SchemaOrder] : [ 3302 ): SchemaList 3303 3304 # Retrieve a schema for structured data ingestions 3305 # Example: 3306 # Request: 3307 # query { 3308 # 3309 # schema(id: "21a08123-45dc-497e-b329-360d9f3fcaac") { 3310 # 3311 # definition 3312 # 3313 # status 3314 # 3315 # } 3316 # } 3317 # Response: 3318 # { 3319 # 3320 # "data": { 3321 # 3322 # "schema": { 3323 # 3324 # "definition": { 3325 # 3326 # "example": "example value" 3327 # 3328 # }, 3329 # 3330 # "status": "draft" 3331 # 3332 # } 3333 # 3334 # } 3335 # } 3336 # 3337 # Arguments 3338 # id: Supply the ID of the schema to retrieve 3339 ID!): Schema ( : 3340 3341 # Example: 3342 # Request: 3343 # query { 3344 # 3345 # schemaProperties(limit: 2) { 3346 # 3347 # records { 3348 # 3349 # type 3350 # 3351 # dataRegistryId 3352 # 3353 # } 3354 # 3355 # } 3356 # } 3357 # Response: 3358 # { 3359 # 3360 # "data": { 3361 # 3362 # "schemaProperties": { 3363 # 3364 # "records": [ 3365 # 3366 # { 3367 # 3368 # "type": "string", 3369 # 3370 # "dataRegistryId": "c3c9fa66-15b2-4bc4-b37f-c790e3ea0db6" 3371 # 3372 # }, 3373 # 3374 # { 3375 # 3376 # "type": "string", 3377 # 3378 # "dataRegistryId": "dbfa78af-f935-4ace-8a70-f70ca36ce49c" 3379 # 3380 # } 3381 # 3382 # ] 3383 # 3384 # } 3385 # 3386 # } 3387 # } 3388 # 3389 # Arguments 3390 # limit: Limit 3391 # offset: Offset 3392 ( 3393 DataRegistryVersion!], : [ 3394 String, : 3395 Int, : 3396 Int : 3397 ): SchemaPropertyList 3398 3399 # Retrieve a structured data object 3400 # Example: 3401 # Request: 3402 # query { 3403 # 3404 # structuredData( 3405 # 3406 # id: "bbc0d388-b7ed-4073-9760-cb7701130eaf", 3407 # 3408 # schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9") { 3409 # 3410 # data 3411 # 3412 # } 3413 # } 3414 # Response: 3415 # { 3416 # 3417 # "data": { 3418 # 3419 # "structuredData": { 3420 # 3421 # "data": { 3422 # 3423 # "example": "example" 3424 # 3425 # } 3426 # 3427 # } 3428 # 3429 # } 3430 # } 3431 # 3432 # Arguments 3433 # id: Supply the ID of the structured data object to retrieve. 3434 # This will override filters. 3435 # schemaId: Schema Id for the structured data object to retrieve 3436 ID!, : ID!): StructuredData ( : 3437 3438 # Retrieve a structured data object 3439 # Example: 3440 # Request: 3441 # query { 3442 # 3443 # structuredDataObject( 3444 # 3445 # id: "bbc0d388-b7ed-4073-9760-cb7701130eaf", 3446 # 3447 # schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9") { 3448 # 3449 # data 3450 # 3451 # } 3452 # } 3453 # Response: 3454 # { 3455 # 3456 # "data": { 3457 # 3458 # "structuredDataObject": { 3459 # 3460 # "data": { 3461 # 3462 # "example": "example" 3463 # 3464 # } 3465 # 3466 # } 3467 # 3468 # } 3469 # } 3470 # 3471 # Arguments 3472 # id: Supply the ID of the structured data object to retrieve. 3473 # This will override filters. 3474 # schemaId: Schema Id for the structured data object to retrieve 3475 ID!, : ID!): StructuredData ( : 3476 3477 # Retrieve a paginated list of structured data object 3478 # Example: 3479 # Request: 3480 # query { 3481 # 3482 # structuredDataObjects(schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9") { 3483 # 3484 # records { 3485 # 3486 # id 3487 # 3488 # data 3489 # 3490 # } 3491 # 3492 # } 3493 # } 3494 # Response: 3495 # { 3496 # 3497 # "data": { 3498 # 3499 # "structuredDataObjects": { 3500 # 3501 # "records": [ 3502 # 3503 # { 3504 # 3505 # "id": "bbc0d388-b7ed-4073-9760-cb7701130eaf", 3506 # 3507 # "data": { 3508 # 3509 # "example": "example" 3510 # 3511 # } 3512 # 3513 # }, 3514 # 3515 # { 3516 # 3517 # "id": "f914eafe-ed9b-46b1-a48d-effd5575764a", 3518 # 3519 # "data": { 3520 # 3521 # "example": "example" 3522 # 3523 # } 3524 # 3525 # } 3526 # 3527 # ] 3528 # 3529 # } 3530 # 3531 # } 3532 # } 3533 # 3534 # Arguments 3535 # id: Supply the ID of the structured data object to retrieve. 3536 # This will override filters. 3537 # ids: List of Ids of the structured data objects to retrieve. 3538 # This will override filters. 3539 # schemaId: Schema Id for the structured data object to retrieve 3540 # filter: Passing id or ids argument will override the filter. 3541 # Any field in the SDO's data column can be used as a filter with 'exact match' 3542 # comparison. 3543 # E.g.: 3544 # 3545 # filter: { 3546 # 3547 # name: "This is an example" 3548 # 3549 # } 3550 ( 3551 ID, : 3552 ID!], : [ 3553 ID!, : 3554 StructuredDataOrderBy!], : [ 3555 Int, : 3556 Int, : 3557 Boolean, : 3558 JSONData, : 3559 SdoDateTimeFilter : 3560 ): StructuredDataList 3561 3562 # Returns information about the GraphQL server, useful 3563 # for diagnostics. This data is primarily used by Veritone 3564 # development, and some fields may be restricted to Veritone administrators. 3565 GraphQLServiceInfo : 3566 3567 # Returns a signed writable S3 URL. A client can then 3568 # upload to this URL with an HTTP PUT without providing 3569 # any additional authorization (_note_: it must be a PUT. 3570 # A POST will fail.) 3571 # Example: 3572 # Request: 3573 # query { 3574 # 3575 # getSignedWritableUrl(type: "preview") { 3576 # 3577 # bucket 3578 # 3579 # key 3580 # 3581 # url 3582 # 3583 # } 3584 # } 3585 # Response: 3586 # { 3587 # 3588 # "data": { 3589 # 3590 # "getSignedWritableUrl": { 3591 # 3592 # "bucket": "prod-api.veritone.com", 3593 # 3594 # "key": 3595 # "35521/preview/2021/5/5/_/19-50-374_ed2c10a7-6f96-4d7c-a498-7bedeb383c7e", 3596 # 3597 # "url": 3598 # "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" 3599 # 3600 # } 3601 # 3602 # } 3603 # } 3604 # 3605 # Arguments 3606 # key: Optional key of the object to generate a writable 3607 # URL for. If not provided, a new, unique key will 3608 # be generated. If a key is provided and resembles a file name 3609 # (with extension delimited by .), a UUID will be inserted 3610 # into the file name, leaving the extension intact. 3611 # If a key is provided and does not resemble 3612 # a file name, a UUID will be appended. 3613 # type: Optional type of resource, such as `asset`, `thumbnail`, 3614 # `discovery-analytics` or `preview` 3615 # path: Optional extended path information. If the uploaded 3616 # content will be contained 3617 # within a container such as a `TemporalDataObject` (for `asset`) or `Library` 3618 # (for `entityIdentifier`), the ID of the object should be provided here. 3619 # expiresInSeconds: Optional expiresInSeconds custom expiration 3620 # to signedUrlExpires 3621 # Max expiresInSeconds up to 604800 3622 # organizationId: Optional organization ID. Normally this value 3623 # is computed by the server 3624 # based on the authorization token used for the request. 3625 # Is is used only by Veritone platform components. 3626 ( 3627 String, : 3628 String, : 3629 String, : 3630 Int, : 3631 ID : 3632 ): WritableUrlInfo 3633 3634 # Return writable storage URLs in bulk. 3635 # A maximum of 1000 can be created in one call. 3636 # See `getSignedWritableUrl` for details on usage of the 3637 # response contents. 3638 # Example: 3639 # Request: 3640 # query { 3641 # 3642 # getSignedWritableUrls(number: 2) { 3643 # 3644 # bucket 3645 # 3646 # key 3647 # 3648 # url 3649 # 3650 # } 3651 # } 3652 # Response: 3653 # { 3654 # 3655 # "data": { 3656 # 3657 # "getSignedWritableUrls": [ 3658 # 3659 # { 3660 # 3661 # "bucket": "prod-api.veritone.com", 3662 # 3663 # "key": "35521/other/2021/5/5/_/19-19-384_723ca284-cee6-4883-af16-edcbfed86433", 3664 # 3665 # "url": 3666 # "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" 3667 # 3668 # }, 3669 # 3670 # { 3671 # 3672 # "bucket": "prod-api.veritone.com", 3673 # 3674 # "key": "35521/other/2021/5/6/_/19-19-384_76af4aeb-5d9b-4bc4-b1d0-251e3f57b651", 3675 # 3676 # "url": 3677 # "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" 3678 # 3679 # } 3680 # 3681 # ] 3682 # 3683 # } 3684 # } 3685 # 3686 # Arguments 3687 # number: Number of signed URLs to return 3688 # type: Optional type of resource, such as `asset`, `thumbnail`, 3689 # or `preview` 3690 # path: Optional extended path information. If the uploaded 3691 # content will be contained 3692 # within a container such as a `TemporalDataObject` (for `asset`) or `Library` 3693 # (for `entityIdentifier`), the ID of the object should be provided here. 3694 # organizationId: Optional organization ID. Normally this value 3695 # is computed by the server 3696 # based on the authorization token used for the request. 3697 # Is is used only by Veritone platform components. 3698 ( 3699 Int!, : 3700 String, : 3701 String, : 3702 ID : 3703 ): [WritableUrlInfo!]! 3704 3705 # Retrieve the rights of the current user 3706 # Example: 3707 # Request: 3708 # query { 3709 # 3710 # myRights { 3711 # 3712 # resources 3713 # 3714 # operations 3715 # 3716 # } 3717 # } 3718 # Response: 3719 # { 3720 # 3721 # "data": { 3722 # 3723 # "myRights": { 3724 # 3725 # "resources": {}, 3726 # 3727 # "operations": [ 3728 # 3729 # "admin.access", 3730 # 3731 # "admin.org.read", 3732 # 3733 # "admin.org.update", 3734 # 3735 # "admin.user.create", 3736 # 3737 # "admin.user.read", 3738 # 3739 # "admin.user.update", 3740 # 3741 # "admin.user.delete", 3742 # 3743 # ... 3744 # 3745 # ] 3746 # 3747 # } 3748 # 3749 # } 3750 # } 3751 RightsListing : 3752 3753 # Retrieve the shared folders for an organization 3754 # Example: 3755 # Request: 3756 # query { 3757 # 3758 # sharedFolders { 3759 # 3760 # id 3761 # 3762 # } 3763 # } 3764 # Response: 3765 # { 3766 # 3767 # "data": { 3768 # 3769 # "sharedFolders": [] 3770 # 3771 # } 3772 # } 3773 Folder] : [ 3774 3775 # Retrieve multiple watchlists 3776 # Example: 3777 # Request: 3778 # query { 3779 # 3780 # watchlists(limit: 2) { 3781 # 3782 # records { 3783 # 3784 # id 3785 # 3786 # name 3787 # 3788 # } 3789 # 3790 # } 3791 # } 3792 # Response: 3793 # { 3794 # 3795 # "data": { 3796 # 3797 # "watchlists": { 3798 # 3799 # "records": [ 3800 # 3801 # { 3802 # 3803 # "id": "326916", 3804 # 3805 # "name": "example" 3806 # 3807 # }, 3808 # 3809 # { 3810 # 3811 # "id": "325791", 3812 # 3813 # "name": "example" 3814 # 3815 # } 3816 # 3817 # ] 3818 # 3819 # } 3820 # 3821 # } 3822 # } 3823 # 3824 # Arguments 3825 # isDisabled: Set `true` to include only disabled watchlist or 3826 # `false` to include only enabled watchlists. By default, 3827 # both are included. 3828 # names: Provide a list of names to filter folders 3829 ( 3830 ID, : 3831 DateTime, : 3832 DateTime, : 3833 DateTime, : 3834 DateTime, : 3835 String, : 3836 Int, : 3837 Int, : 3838 WatchlistOrderBy, : 3839 OrderDirection, : 3840 Boolean, : 3841 String], : [ 3842 StringMatch : 3843 ): WatchlistList 3844 3845 # Retrieve a single watchlist by id 3846 # Example: 3847 # Request: 3848 # query { 3849 # 3850 # watchlist(id: "325791") { 3851 # 3852 # name 3853 # 3854 # watchlistType 3855 # 3856 # } 3857 # } 3858 # Response: 3859 # { 3860 # 3861 # "data": { 3862 # 3863 # "watchlist": { 3864 # 3865 # "name": "example", 3866 # 3867 # "watchlistType": "tracking" 3868 # 3869 # } 3870 # 3871 # } 3872 # } 3873 ID!): Watchlist ( : 3874 3875 # Example: 3876 # Request: 3877 # query { 3878 # 3879 # mentionStatusOptions { 3880 # 3881 # id 3882 # 3883 # name 3884 # 3885 # } 3886 # } 3887 # Response: 3888 # { 3889 # 3890 # "data": { 3891 # 3892 # "mentionStatusOptions": [ 3893 # 3894 # { 3895 # 3896 # "id": "7", 3897 # 3898 # "name": "Auto Verified" 3899 # 3900 # }, 3901 # 3902 # { 3903 # 3904 # "id": "5", 3905 # 3906 # "name": "Invalid" 3907 # 3908 # }, 3909 # 3910 # { 3911 # 3912 # "id": "3", 3913 # 3914 # "name": "Needs Review" 3915 # 3916 # }, 3917 # 3918 # { 3919 # 3920 # "id": "1", 3921 # 3922 # "name": "Pending Verification" 3923 # 3924 # }, 3925 # 3926 # { 3927 # 3928 # "id": "6", 3929 # 3930 # "name": "Processing Verification" 3931 # 3932 # }, 3933 # 3934 # { 3935 # 3936 # "id": "4", 3937 # 3938 # "name": "Request Bonus" 3939 # 3940 # }, 3941 # 3942 # { 3943 # 3944 # "id": "2", 3945 # 3946 # "name": "Verified" 3947 # 3948 # } 3949 # 3950 # ] 3951 # 3952 # } 3953 # } 3954 MentionStatus!]! : [ 3955 3956 # Retrieve multiple data registries 3957 # Example: 3958 # Request: 3959 # query { 3960 # 3961 # dataRegistries(limit: 2) { 3962 # 3963 # records { 3964 # 3965 # id 3966 # 3967 # name 3968 # 3969 # } 3970 # 3971 # } 3972 # } 3973 # Response: 3974 # { 3975 # 3976 # "data": { 3977 # 3978 # "dataRegistries": { 3979 # 3980 # "records": [ 3981 # 3982 # { 3983 # 3984 # "id": "532ef261-d3a4-4c09-8fc7-0653a5131577", 3985 # 3986 # "name": "example" 3987 # 3988 # }, 3989 # 3990 # { 3991 # 3992 # "id": "317c941d-30d0-455e-882b-34a26e513364", 3993 # 3994 # "name": "example" 3995 # 3996 # } 3997 # 3998 # ] 3999 # 4000 # } 4001 # 4002 # } 4003 # } 4004 ( 4005 ID, : 4006 ID!], : [ 4007 String, : 4008 StringMatch, : 4009 Int, : 4010 Int, : 4011 DataRegistryOrderBy, : 4012 OrderDirection, : 4013 SchemaOwnership : 4014 ): DataRegistryList 4015 4016 # Retrieve a single data registry 4017 # Example: 4018 # Request: 4019 # query { 4020 # 4021 # dataRegistry(id: "532ef261-d3a4-4c09-8fc7-0653a5131577") { 4022 # 4023 # name 4024 # 4025 # organizationId 4026 # 4027 # source 4028 # 4029 # } 4030 # } 4031 # Response: 4032 # { 4033 # 4034 # "data": { 4035 # 4036 # "dataRegistry": { 4037 # 4038 # "name": "example", 4039 # 4040 # "organizationId": "35521", 4041 # 4042 # "source": "veritone-35521.datasets" 4043 # 4044 # } 4045 # 4046 # } 4047 # } 4048 ID!): DataRegistry ( : 4049 4050 # Retrieve a subscription by id 4051 # Example: 4052 # Request: 4053 # query { 4054 # 4055 # subscription(id: "275818") { 4056 # 4057 # isActive 4058 # 4059 # jsondata 4060 # 4061 # } 4062 # } 4063 # Response: 4064 # { 4065 # 4066 # "data": { 4067 # 4068 # "subscription": { 4069 # 4070 # "isActive": true, 4071 # 4072 # "jsondata": { 4073 # 4074 # "tracking_unit_id": "325791", 4075 # 4076 # "creator_email": "example email", 4077 # 4078 # "unsubscribe_hash": 4079 # "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0cmFja2luZ1VuaXQiOiJ0cmFja2luZ191bml0X2lkIiwiZW1haWxBZGRyZXNzIjoiZW1haWxfYWRkcmVzcyIsInRyYWNraW5nX3VuaXRfaWQiOiIzMjU3OTEiLCJlbWFpbF9hZGRyZXNzIjoiZXhhbXBsZSBlbWFpbCIsImlhdCI6MTYyNDAyMjY4OCwiaXNzIjoidmVyaXRvbmU6ZGlzY292ZXJ5Iiwic3ViIjoidW5zdWJzY3JpYmUifQ.stYGS_goXaEhwLbKtYRohPirUT-q6vuY5hMHt74BWMUuEWYhwAQBxMItoFjZSXc3lHolQutxsl_BDiMOWNS4snRvcn-jI-5HG_4A3gEjQc6sYbgtyeVGxuDAg4urtj5sSBz0AU0xXZwLp2NI0Q39dqQSi1v1ZFANFE-jGULHreE3h617hLKf6CvegaOyrn_wqNONsB6VKDbXoLxdWoYJu3k7UztbvD1SC_bYHc7ltd1Ua2blUXSH0eBlk7pSv1vWdpw9KwMeuPJdC3R3qOB3-0xtp7KzTs0f5TelSZbk-6keVJz4LQt2mDxs6uivd8wb6GJ6Ikw-uKUYuo3T-vL0p-hFA5DkwiToomqTIqXvF5DGJxx762bKLLEKALAC55LdJ7eCZc6DmrnRbYLYNVfc2jK9YBDKeZxUAjNmYvlRsQTpLIrLoxWWmCbOJznfEjrzp_gI24rUh5qZ_-KUHr0pEYd5DuURy_geCmwSedq-nHV8tlE7op1bX8k9fwWFjIS7JIjYquUJq9T2wqIORO0WN6DGhgqkL7texbx9IYSWRkAY26KQxUF08jm5Vh_jrkmRyXsS9r5kVn_AGXbMA_HqtFo2jvXw5OXDcuaRjYwJpf8YtMvjNuDl8t9gbSmKwbeG1FsErPX0ne5K2TRWIqolohIvdHTTfsZLVvWdwmASnYw" 4080 # 4081 # } 4082 # 4083 # } 4084 # 4085 # } 4086 # } 4087 ID!): Subscription! ( : 4088 4089 ID!): CognitiveSearch! ( : 4090 4091 # Retrieve multiple collections 4092 # Example: 4093 # Request: 4094 # query { 4095 # 4096 # collections { 4097 # 4098 # records { 4099 # 4100 # id 4101 # 4102 # name 4103 # 4104 # } 4105 # 4106 # } 4107 # } 4108 # Response: 4109 # { 4110 # 4111 # "data": { 4112 # 4113 # "collections": { 4114 # 4115 # "records": [ 4116 # 4117 # { 4118 # 4119 # "id": "241121", 4120 # 4121 # "name": "example" 4122 # 4123 # }, 4124 # 4125 # { 4126 # 4127 # "id": "242599", 4128 # 4129 # "name": "example" 4130 # 4131 # }, 4132 # 4133 # { 4134 # 4135 # "id": "243625", 4136 # 4137 # "name": "example" 4138 # 4139 # } 4140 # 4141 # ] 4142 # 4143 # } 4144 # 4145 # } 4146 # } 4147 ID, : String, : ID, : Int, : Int): CollectionList! ( : 4148 4149 # Retrieve a collection by id 4150 # Example: 4151 # Request: 4152 # query { 4153 # 4154 # collection(id: "241121") { 4155 # 4156 # name 4157 # 4158 # isActive 4159 # 4160 # } 4161 # } 4162 # Response: 4163 # { 4164 # 4165 # "data": { 4166 # 4167 # "collection": { 4168 # 4169 # "name": "example", 4170 # 4171 # "isActive": true 4172 # 4173 # } 4174 # 4175 # } 4176 # } 4177 ID!): Collection! ( : 4178 4179 ID!, : ID!): CollectionMention! ( : 4180 4181 # Retrieve a list of collection mentions 4182 # Specify at least one of folderId or mentionId 4183 ( 4184 ID, : 4185 ID, : 4186 CollectionMentionOrderBy, : 4187 Int, : 4188 Int : 4189 ): CollectionMentionList! 4190 4191 # Retrieve multiple mentions 4192 # Example: 4193 # Request: 4194 # query { 4195 # 4196 # mentions { 4197 # 4198 # records { 4199 # 4200 # id 4201 # 4202 # } 4203 # 4204 # } 4205 # } 4206 # Response: 4207 # { 4208 # 4209 # "data": { 4210 # 4211 # "mentions": { 4212 # 4213 # "records": [] 4214 # 4215 # } 4216 # 4217 # } 4218 # } 4219 # 4220 # Arguments 4221 # watchlistId: Get mentions created from the specified watchlist 4222 # sourceId: Get mentions associated with the specified source 4223 # sourceTypeId: Get mentions associated with sources of the 4224 # specified source type 4225 # tdoId: Get mentions associated directly with the specific TDO 4226 # dateTimeFilter: Specify date/time filters against mention 4227 # fields. 4228 # Querying for mentions can be expensive. If the query does not 4229 # include a filter by `id`, `tdoId`, `sourceId`, `watchlistId`, or 4230 # a user-provided `dateTimeFilter`, a default filter of the 4231 # past 7 days is applied. 4232 # orderBy: Set order information on the query. Multiple fields 4233 # are supported. 4234 # folderId: Provide a folder ID to filter by collection 4235 ( 4236 ID, : 4237 ID, : 4238 ID, : 4239 ID, : 4240 ID, : 4241 MentionDateTimeFilter!], : [ 4242 MentionOrderBy!], : [ 4243 Int, : 4244 Int, : 4245 ID : 4246 ): MentionList 4247 4248 # Retrieves engine results by TDO and engine ID or by job ID. 4249 # Example: 4250 # Request: 4251 # query { 4252 # 4253 # engineResults( 4254 # 4255 # tdoId: "1580507556", 4256 # 4257 # engineIds: "4") { 4258 # 4259 # sourceId 4260 # 4261 # records { 4262 # 4263 # tdoId 4264 # 4265 # } 4266 # 4267 # } 4268 # } 4269 # Response: 4270 # { 4271 # 4272 # "data": { 4273 # 4274 # "engineResults": { 4275 # 4276 # "sourceId": null, 4277 # 4278 # "records": [] 4279 # 4280 # } 4281 # 4282 # } 4283 # } 4284 # 4285 # Arguments 4286 # tdoId: Provide the ID of the TDO containing engine results to 4287 # retrieve. 4288 # If this parameter is used, engineIds or engineCategoryIds must also be set. 4289 # Results for _only_ the specified TDO will be returned. 4290 # sourceId: Provide the ID of the Source containing engine 4291 # results to retrieve. 4292 # If this parameter is used, engineIds or engineCategoryIds must also be set. 4293 # This takes priority over tdoId. 4294 # engineIds: Provide one or more engine IDs to retrieve engine 4295 # results by 4296 # ID. This parameter is mandatory if tdoId is used, but optional 4297 # if jobId or engineCategory is used. 4298 # engineCategoryIds: Provide one or more category IDs to get all 4299 # results from that categroy. 4300 # jobId: Provide a job ID to retrieve engine results for the job. 4301 # mentionId: Provide a mention ID to retrieve engine results for 4302 # the mention. 4303 # startOffsetMs: Start offset ms for the results. 4304 # stopOffsetMs: End offset ms for the results. 4305 # startDate: Start date for the results. Takes priority over 4306 # startOffsetMs. 4307 # stopDate: End date for the results. Takes priority over 4308 # stopOffsetMs. 4309 # ignoreUserEdited: Whether or not to exclude user edited engine 4310 # results. Defaults to false. 4311 # fallbackTdoId: A TDO ID can be provided for use if the provided 4312 # `sourceId` and/or 4313 # `mentionId` parameters do not resolve to a logical set of TDOs. 4314 # Depending on parameter settings and available data, 4315 # results from other TDOs can be included in the response. 4316 ( 4317 ID, : 4318 ID, : 4319 ID!], : [ 4320 ID!], : [ 4321 ID, : 4322 ID, : 4323 Int, : 4324 Int, : 4325 DateTime, : 4326 DateTime, : 4327 Boolean, : 4328 ID : 4329 ): EngineResultList 4330 4331 # Retrieve a trigger by id 4332 # Example: 4333 # Request: 4334 # query { 4335 # 4336 # trigger(id: "2998") { 4337 # 4338 # target 4339 # 4340 # createdDateTime 4341 # 4342 # } 4343 # } 4344 # Response: 4345 # { 4346 # 4347 # "data": { 4348 # 4349 # "trigger": { 4350 # 4351 # "target": "Email", 4352 # 4353 # "createdDateTime": "2021-06-18T13:35:08.631Z" 4354 # 4355 # } 4356 # 4357 # } 4358 # } 4359 ID!): Trigger ( : 4360 4361 # Retrieve triggers 4362 # Example: 4363 # Request: 4364 # query { 4365 # 4366 # triggers { 4367 # 4368 # id 4369 # 4370 # } 4371 # } 4372 # Response: 4373 # { 4374 # 4375 # "data": { 4376 # 4377 # "triggers": [ 4378 # 4379 # { 4380 # 4381 # "id": "2998" 4382 # 4383 # } 4384 # 4385 # ] 4386 # 4387 # } 4388 # } 4389 Trigger] : [ 4390 4391 # Fetch all saved searches that the current user has made 4392 # Fetch all saved searches that have been shared with 4393 # the current users organization 4394 # Include any saved searches that the user has created 4395 # Example: 4396 # Request: 4397 # query { 4398 # 4399 # savedSearches { 4400 # 4401 # records { 4402 # 4403 # id 4404 # 4405 # name 4406 # 4407 # } 4408 # 4409 # } 4410 # } 4411 # Response: 4412 # { 4413 # 4414 # "data": { 4415 # 4416 # "savedSearches": { 4417 # 4418 # "records": [ 4419 # 4420 # { 4421 # 4422 # "id": "3aa9fecb-d3cb-4fa5-a11b-20e02ae494b9", 4423 # 4424 # "name": "example" 4425 # 4426 # } 4427 # 4428 # ] 4429 # 4430 # } 4431 # 4432 # } 4433 # } 4434 ( 4435 Int, : 4436 Int, : 4437 Boolean, : 4438 String, : 4439 SavedSearchOrderBy, : 4440 OrderDirection : 4441 ): SavedSearchList! 4442 4443 # Retrieve a list of export requests 4444 # Example: 4445 # Request: 4446 # query { 4447 # 4448 # exportRequests(limit: 2) { 4449 # 4450 # records { 4451 # 4452 # id 4453 # 4454 # organizationId 4455 # 4456 # } 4457 # 4458 # } 4459 # } 4460 # Response: 4461 # { 4462 # 4463 # "data": { 4464 # 4465 # "exportRequests": { 4466 # 4467 # "records": [ 4468 # 4469 # { 4470 # 4471 # "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad", 4472 # 4473 # "organizationId": "35521" 4474 # 4475 # } 4476 # 4477 # ] 4478 # 4479 # } 4480 # 4481 # } 4482 # } 4483 # 4484 # Arguments 4485 # id: Provide an ID to retrieve a single export request 4486 # offset: Provide an offset to skip to a certain element in the 4487 # result, for paging. 4488 # limit: Specify maximum number of results to retrieve in this 4489 # result. Page size. 4490 # status: Provide a list of status options to filter by status 4491 # event: Provide an event to retrieve export request. Should be 4492 # 'exportRequest' or 'mentionExportRequest' 4493 # Default value is 'exportRequest' 4494 ( 4495 ID, : 4496 Int, : 4497 Int, : 4498 ExportRequestStatus!], : [ 4499 ExportRequestEvent : 4500 ): ExportRequestList! 4501 4502 # Retrieve a single export request by id 4503 # Example: 4504 # Request: 4505 # query { 4506 # 4507 # exportRequest(id: "938b2d64-6df1-486b-b6ea-29d33dee49ad") { 4508 # 4509 # id 4510 # 4511 # organizationId 4512 # 4513 # requestorId 4514 # 4515 # status 4516 # 4517 # } 4518 # } 4519 # Response: 4520 # { 4521 # 4522 # "data": { 4523 # 4524 # "exportRequest": { 4525 # 4526 # "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad", 4527 # 4528 # "organizationId": "35521", 4529 # 4530 # "requestorId": "59cb4e74-7c31-4267-b91e-d4600bc08008", 4531 # 4532 # "status": "complete" 4533 # 4534 # } 4535 # 4536 # } 4537 # } 4538 # 4539 # Arguments 4540 # event: Provide an event to retrieve export request. Should be 4541 # 'exportRequest' or 'mentionExportRequest' 4542 # Default value is 'exportRequest' 4543 ID!, : ExportRequestEvent): ExportRequest! ( : 4544 4545 # Retrieve a event by id 4546 # Example: 4547 # Request: 4548 # query { 4549 # 4550 # event(id: "55fc7c51-1521-4043-902f-f0f3a357da6d") { 4551 # 4552 # eventName 4553 # 4554 # eventType 4555 # 4556 # description 4557 # 4558 # } 4559 # } 4560 # Response: 4561 # { 4562 # 4563 # "data": { 4564 # 4565 # "event": { 4566 # 4567 # "eventName": "example", 4568 # 4569 # "eventType": "example", 4570 # 4571 # "description": "new example description" 4572 # 4573 # } 4574 # 4575 # } 4576 # } 4577 ID!): Event ( : 4578 4579 # Retrieve a list of events by application 4580 # Example: 4581 # Request: 4582 # query { 4583 # 4584 # events( 4585 # 4586 # application: "system", 4587 # 4588 # limit: 2) { 4589 # 4590 # records { 4591 # 4592 # id 4593 # 4594 # eventName 4595 # 4596 # } 4597 # 4598 # } 4599 # } 4600 # Response: 4601 # { 4602 # 4603 # "data": { 4604 # 4605 # "events": { 4606 # 4607 # "records": [ 4608 # 4609 # { 4610 # 4611 # "id": "8876aa2f-1068-411d-b746-28c867c151cc", 4612 # 4613 # "eventName": "ActionTokenForbidden" 4614 # 4615 # }, 4616 # 4617 # { 4618 # 4619 # "id": "d5082d0e-3c96-4c71-9f27-c679650f2adf", 4620 # 4621 # "eventName": "ActionUserForbidden" 4622 # 4623 # } 4624 # 4625 # ] 4626 # 4627 # } 4628 # 4629 # } 4630 # } 4631 # 4632 # Arguments 4633 # application: Provide an application to retrieve all its events. 4634 # Use 'system' to list all public system events. 4635 # offset: Provide an offset to skip to a certain element in the 4636 # result, for paging. 4637 # limit: Specify maximum number of results to retrieve in this 4638 # result. Page size. 4639 String!, : Int, : Int): EventList! ( : 4640 4641 # Retrieve a list of subscriptions by organization 4642 # Example: 4643 # Request: 4644 # query { 4645 # 4646 # eventSubscriptions(limit: 2) { 4647 # 4648 # records { 4649 # 4650 # id 4651 # 4652 # eventName 4653 # 4654 # } 4655 # 4656 # } 4657 # } 4658 # Response: 4659 # { 4660 # 4661 # "data": { 4662 # 4663 # "eventSubscriptions": { 4664 # 4665 # "records": [ 4666 # 4667 # { 4668 # 4669 # "id": "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194", 4670 # 4671 # "eventName": "LibraryTrainingComplete" 4672 # 4673 # }, 4674 # 4675 # { 4676 # 4677 # "id": "c7c4a969-4500-4d7b-b77f-81b1e64bf112", 4678 # 4679 # "eventName": "LibraryTrainingComplete" 4680 # 4681 # } 4682 # 4683 # ] 4684 # 4685 # } 4686 # 4687 # } 4688 # } 4689 # 4690 # Arguments 4691 # ids: The event subscription ids 4692 # eventName: The name of the event 4693 # eventType: The type of event, such as `mention`, `job`, 4694 # `engine`. 4695 # offset: Provide an offset to skip to a certain element in the 4696 # result, for paging. 4697 # limit: Specify maximum number of results to retrieve in this 4698 # result. Page size. 4699 # orgId: The organization ID with which these event subscriptions 4700 # are associated. 4701 # appId: The application ID with which these event subscriptions 4702 # are associated. 4703 # scope: Event subscription scope 4704 ( 4705 ID!], : [ 4706 String, : 4707 String, : 4708 Int, : 4709 Int, : 4710 ID, : 4711 ID, : 4712 EventSubscriptionScope : 4713 ): EventSubscriptionList! 4714 4715 # Retrieve a subscription by id 4716 # Example: 4717 # Request: 4718 # query { 4719 # 4720 # eventSubscription(id: "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194") { 4721 # 4722 # id 4723 # 4724 # organizationId 4725 # 4726 # eventName 4727 # 4728 # targetName 4729 # 4730 # } 4731 # } 4732 # Response: 4733 # { 4734 # 4735 # "data": { 4736 # 4737 # "eventSubscription": { 4738 # 4739 # "id": "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194", 4740 # 4741 # "organizationId": "35521", 4742 # 4743 # "eventName": "LibraryTrainingComplete", 4744 # 4745 # "targetName": "NotificationMailbox" 4746 # 4747 # } 4748 # 4749 # } 4750 # } 4751 ID!): EventSubscription! ( : 4752 4753 # Example: 4754 # Request: 4755 # query { 4756 # 4757 # eventActionTemplate(id: "d02522d7-ef5f-448f-981a-d2cfc7603d92") { 4758 # 4759 # organizationId 4760 # 4761 # actionType 4762 # 4763 # name 4764 # 4765 # } 4766 # } 4767 # Response: 4768 # { 4769 # 4770 # "data": { 4771 # 4772 # "eventActionTemplate": { 4773 # 4774 # "organizationId": "35521", 4775 # 4776 # "actionType": "job", 4777 # 4778 # "name": "example" 4779 # 4780 # } 4781 # 4782 # } 4783 # } 4784 ID!): EventActionTemplate ( : 4785 4786 # Example: 4787 # Request: 4788 # query { 4789 # 4790 # eventActionTemplates( 4791 # 4792 # inputType: event, 4793 # 4794 # actionType: job 4795 # 4796 # limit:2) { 4797 # 4798 # records { 4799 # 4800 # id 4801 # 4802 # name 4803 # 4804 # } 4805 # 4806 # } 4807 # } 4808 # Response: 4809 # { 4810 # 4811 # "data": { 4812 # 4813 # "eventActionTemplates": { 4814 # 4815 # "records": [ 4816 # 4817 # { 4818 # 4819 # "id": "d02522d7-ef5f-448f-981a-d2cfc7603d92", 4820 # 4821 # "name": "example" 4822 # 4823 # }, 4824 # 4825 # { 4826 # 4827 # "id": "49d28375-b6b2-418e-b965-8e939d1189ae", 4828 # 4829 # "name": "example" 4830 # 4831 # } 4832 # 4833 # ] 4834 # 4835 # } 4836 # 4837 # } 4838 # } 4839 # 4840 # Arguments 4841 # ownerApplicationId: The application id 4842 # inputType: use "event" for now. In the future, we allow 4843 # additional input_type types. For example, a schedule or a tweet. 4844 # actionType: Either "job", "webhook", "sms", "email". Future 4845 # action_type could be "gql" where action is purely a function call. 4846 # offset: Provide an offset to skip to a certain element in the 4847 # result, for paging. 4848 # limit: Specify maximum number of results to retrieve in this 4849 # result. Page size. 4850 ( 4851 ID, : 4852 EventActionTemplateInputType, : 4853 EventActionTemplateActionType, : 4854 Int, : 4855 Int : 4856 ): EventActionTemplateList! 4857 4858 # Example: 4859 # Request: 4860 # query { 4861 # 4862 # eventCustomRule(id: "c2c1ee13-37d2-4f92-9156-5cb1a3c59ed5") { 4863 # 4864 # name 4865 # 4866 # eventName 4867 # 4868 # description 4869 # 4870 # } 4871 # } 4872 # Response: 4873 # { 4874 # 4875 # "data": { 4876 # 4877 # "eventCustomRule": { 4878 # 4879 # "name": "example", 4880 # 4881 # "eventName": "example", 4882 # 4883 # "description": "example description" 4884 # 4885 # } 4886 # 4887 # } 4888 # } 4889 ID!): EventCustomRule ( : 4890 4891 # Example: 4892 # Request: 4893 # query { 4894 # 4895 # eventCustomRules(limit: 2) { 4896 # 4897 # records { 4898 # 4899 # id 4900 # 4901 # name 4902 # 4903 # } 4904 # 4905 # } 4906 # } 4907 # Response: 4908 # { 4909 # 4910 # "data": { 4911 # 4912 # "eventCustomRules": { 4913 # 4914 # "records": [ 4915 # 4916 # { 4917 # 4918 # "id": "c2c1ee13-37d2-4f92-9156-5cb1a3c59ed5", 4919 # 4920 # "name": "example" 4921 # 4922 # } 4923 # 4924 # ] 4925 # 4926 # } 4927 # 4928 # } 4929 # } 4930 # 4931 # Arguments 4932 # offset: the offset to skip to a certain element in the result 4933 # limit: the maximum number of rows in the results 4934 Int, : Int): EventCustomRuleList! ( : 4935 4936 # This query returns information about time zones recognized by this 4937 # 4938 # server. The information is static and does not change. 4939 # 4940 # Example: 4941 # 4942 # Request: 4943 # 4944 # query { 4945 # 4946 # timeZones { 4947 # 4948 # name 4949 # 4950 # abbreviations{ 4951 # 4952 # name 4953 # 4954 # } 4955 # 4956 # } 4957 # } 4958 # Response: 4959 # { 4960 # 4961 # "data": { 4962 # 4963 # "timeZones": [ 4964 # 4965 # { 4966 # 4967 # "name": "Africa/Abidjan", 4968 # 4969 # "abbreviations": [ 4970 # 4971 # { 4972 # 4973 # "name": "GMT" 4974 # 4975 # } 4976 # 4977 # ] 4978 # 4979 # }, 4980 # 4981 # { 4982 # 4983 # "name": "Africa/Accra", 4984 # 4985 # "abbreviations": [ 4986 # 4987 # { 4988 # 4989 # "name": "GMT" 4990 # 4991 # }, 4992 # 4993 # { 4994 # 4995 # "name": "+0020" 4996 # 4997 # } 4998 # 4999 # ] 5000 # 5001 # }, 5002 # 5003 # { 5004 # 5005 # "name": "Africa/Lagos", 5006 # 5007 # "abbreviations": [ 5008 # 5009 # { 5010 # 5011 # "name": "WAT" 5012 # 5013 # } 5014 # 5015 # ] 5016 # 5017 # }, 5018 # 5019 # ... 5020 # 5021 # ... 5022 # 5023 # ] 5024 # 5025 # } 5026 # 5027 # ] 5028 # 5029 # } 5030 # } 5031 TimeZone!]! : [ 5032 5033 # Examine entries from the audit log. All operations that modify data are 5034 # written to the audit log. Only entries for the user's own organization 5035 # can be queried. 5036 # All queries are bracketed by a time window. A default time window is applied 5037 # if the `toDateTime` and/or `fromDateTime` parameters are not provided. 5038 # The maximum time window length is 30 days. 5039 # Only Veritone and organization administrators can use this query. 5040 # Example: 5041 # Request: 5042 # query { 5043 # 5044 # auditLog(limit: 2) { 5045 # 5046 # records { 5047 # 5048 # id 5049 # 5050 # objectId 5051 # 5052 # description 5053 # 5054 # } 5055 # 5056 # } 5057 # } 5058 # Response: 5059 # { 5060 # 5061 # "data": { 5062 # 5063 # "auditLog": { 5064 # 5065 # "records": [ 5066 # 5067 # { 5068 # 5069 # "id": "735915311", 5070 # 5071 # "objectId": "*********", 5072 # 5073 # "description": "Changed password" 5074 # 5075 # }, 5076 # 5077 # { 5078 # 5079 # "id": "735915307", 5080 # 5081 # "objectId": "********", 5082 # 5083 # "description": "Changed password" 5084 # 5085 # } 5086 # 5087 # ] 5088 # 5089 # } 5090 # 5091 # } 5092 # } 5093 # 5094 # Arguments 5095 # toDateTime: Date/time up to which entries will be returned. In 5096 # other words, the 5097 # end of the query time window. 5098 # Defaults to the current time. 5099 # fromDateTime: Date/time from which entries will be returned. In 5100 # other words, the 5101 # start of the query time window. 5102 # Defaults to the `toDateTime` minus 7 days. 5103 # organizationId: Organization ID to query records for. This 5104 # value can only be used by 5105 # Veritone administrators. Any value provided by user administrators will 5106 # be ignored. 5107 # userName: User name on audit entry. Must be exact match. 5108 # clientIpAddress: IP address of the client that generated the 5109 # audit action. Must be exact match. 5110 # clientUserAgent: HTTP user agent of the client that generated 5111 # the audit action. Must be exact match. 5112 # eventType: The event type, such as `Create`, `Update`, or 5113 # `Delete`. 5114 # Must be exact match. 5115 # objectId: The ID of the object involved in the audit action. 5116 # The format of this ID 5117 # varies by object type. Must be exact match. 5118 # objectType: The type of the object involved in the audit 5119 # action, such as `Watchlist` 5120 # or `TemporalDataObject`. Must be exact match. 5121 # success: Whether or not the action was successful. 5122 # id: The unique ID of an audit log entry. Multiple values can be 5123 # provided. 5124 # offset: Offset into result set, for paging. 5125 # limit: Limit on result size, for paging (page size). Audit 5126 # queries are 5127 # lightweight so the default of 100 is higher than the default offset 5128 # used elsewhere in the API. 5129 # orderBy: Order information. Default is order by 5130 # `createdDateTime` descending. 5131 ( 5132 DateTime, : 5133 DateTime, : 5134 ID, : 5135 String, : 5136 String, : 5137 String, : 5138 String, : 5139 ID, : 5140 String, : 5141 Boolean, : 5142 ID!], : [ 5143 Int, : 5144 Int, : 5145 AuditLogOrderBy!] : [ 5146 ): AuditLogEntryList! @deprecated( reason: "No longer supported." ) 5147 5148 # Get the media share by media shareId 5149 ID!): MediaShare! ( : 5150 5151 # Retrieve a shared collection 5152 # 5153 # Arguments 5154 # shareId: share token 5155 ID!): SharedCollection ( : 5156 5157 # Retrieve shared collection history records 5158 # Example: 5159 # Request: 5160 # query { 5161 # 5162 # sharedCollectionHistory(limit: 2, 5163 # 5164 # folderId: "d551fbd6-7354-4b0e-abfb-654ab8583be2") { 5165 # 5166 # records { 5167 # 5168 # id 5169 # 5170 # status 5171 # 5172 # shareId 5173 # 5174 # } 5175 # 5176 # } 5177 # } 5178 # Response: 5179 # { 5180 # 5181 # "data": { 5182 # 5183 # "sharedCollectionHistory": { 5184 # 5185 # "records": [] 5186 # 5187 # } 5188 # 5189 # } 5190 # } 5191 # 5192 # Arguments 5193 # ids: Provide an ID to retrieve a single history record 5194 # folderId: Provide a folder ID to filter by collection 5195 # shareId: Provide a share ID to filter by share ID 5196 # offset: Specify maximum number of results to retrieve in this 5197 # result. Page size. 5198 # limit: Specify maximum number of results to retrieve in this 5199 # result. 5200 ( 5201 ID!], : [ 5202 ID, : 5203 String, : 5204 Int, : 5205 Int : 5206 ): SharedCollectionHistoryList! 5207 5208 # Get list process templates by id or current organizationId 5209 # Example: 5210 # Request: 5211 # query { 5212 # 5213 # processTemplates(limit: 2) { 5214 # 5215 # records { 5216 # 5217 # id 5218 # 5219 # organizationId 5220 # 5221 # name 5222 # 5223 # } 5224 # 5225 # } 5226 # } 5227 # Response: 5228 # { 5229 # 5230 # "data": { 5231 # 5232 # "processTemplates": { 5233 # 5234 # "records": [ 5235 # 5236 # { 5237 # 5238 # "id": "762", 5239 # 5240 # "organizationId": "35521", 5241 # 5242 # "name": "example" 5243 # 5244 # } 5245 # 5246 # ] 5247 # 5248 # } 5249 # 5250 # } 5251 # } 5252 ID, : Int, : Int): ProcessTemplateList! ( : 5253 5254 # Get process templates by id 5255 # Example: 5256 # Request: 5257 # query { 5258 # 5259 # processTemplate(id: "762") { 5260 # 5261 # name 5262 # 5263 # organizationId 5264 # 5265 # } 5266 # } 5267 # Response: 5268 # { 5269 # 5270 # "data": { 5271 # 5272 # "processTemplate": { 5273 # 5274 # "name": "example", 5275 # 5276 # "organizationId": "35521" 5277 # 5278 # } 5279 # 5280 # } 5281 # } 5282 ID!): ProcessTemplate! ( : 5283 5284 # Get creative by id with current organizationId 5285 # Example: 5286 # Request: 5287 # query { 5288 # 5289 # creative(id: "25209") { 5290 # 5291 # organizationId 5292 # 5293 # brandId 5294 # 5295 # } 5296 # } 5297 # Response: 5298 # { 5299 # 5300 # "data": { 5301 # 5302 # "creative": { 5303 # 5304 # "organizationId": "35521", 5305 # 5306 # "brandId": null 5307 # 5308 # } 5309 # 5310 # } 5311 # } 5312 ID!): Creative! ( : 5313 5314 # Retrieve list of engine classes 5315 # Example: 5316 # Request: 5317 # query { 5318 # 5319 # engineClasses(limit: 2) { 5320 # 5321 # records { 5322 # 5323 # id 5324 # 5325 # name 5326 # 5327 # description 5328 # 5329 # } 5330 # 5331 # } 5332 # } 5333 # Response: 5334 # { 5335 # 5336 # "data": { 5337 # 5338 # "engineClasses": { 5339 # 5340 # "records": [ 5341 # 5342 # { 5343 # 5344 # "id": "e0283fdf-7f85-472e-b367-59cc8d205ba7", 5345 # 5346 # "name": "audio", 5347 # 5348 # "description": "The input to engines in the Audio class is an audio or video 5349 # file or stream. If your engine processes human speech or voice, it likely 5350 # belongs in the Speech class instead. Audio engines may recognize a specific 5351 # audio segment, such as an advertisement, identify sounds like that of a crying 5352 # baby or detect the presence of audio or music in an audio or video file, for 5353 # example." 5354 # 5355 # }, 5356 # 5357 # { 5358 # 5359 # "id": "1bcfdd35-1e9b-4694-8273-00b19510d164", 5360 # 5361 # "name": "biometrics", 5362 # 5363 # "description": "The input to engines in the Biometrics class may be an image, 5364 # speech or other audio or video file or stream. By definition, the Biometrics 5365 # class covers cognitive analysis related to data points from the human body. 5366 # Biometrics engines may detect or recognize faces, identify face attributes to 5367 # estimate a person's age or ethnicity or verify a person based on their unique 5368 # iris, for example." 5369 # 5370 # } 5371 # 5372 # ] 5373 # 5374 # } 5375 # 5376 # } 5377 # } 5378 # 5379 # Arguments 5380 # id: Provide an ID to retrieve a single specific engine class. 5381 # name: Provide a name, or part of one, to search by class name 5382 # offset: Specify maximum number of results to retrieve in this 5383 # result. Page size. 5384 # limit: Specify maximum number of results to retrieve in this 5385 # result. 5386 ID, : String, : Int, : Int): EngineClassList ( : 5387 5388 # Retrieve a specific engine class 5389 # Example: 5390 # Request: 5391 # query { 5392 # 5393 # engineClass(id: "e0283fdf-7f85-472e-b367-59cc8d205ba7") { 5394 # 5395 # id 5396 # 5397 # name 5398 # 5399 # description 5400 # 5401 # } 5402 # } 5403 # Response: 5404 # { 5405 # 5406 # "data": { 5407 # 5408 # "engineClass": { 5409 # 5410 # "id": "e0283fdf-7f85-472e-b367-59cc8d205ba7", 5411 # 5412 # "name": "audio", 5413 # 5414 # "description": "The input to engines in the Audio class is an audio or video 5415 # file or stream. If your engine processes human speech or voice, it likely 5416 # belongs in the Speech class instead. Audio engines may recognize a specific 5417 # audio segment, such as an advertisement, identify sounds like that of a crying 5418 # baby or detect the presence of audio or music in an audio or video file, for 5419 # example." 5420 # 5421 # } 5422 # 5423 # } 5424 # } 5425 # 5426 # Arguments 5427 # id: Supply the ID of the engine class to retrieve 5428 ID!): EngineClass ( : 5429 5430 # Retrieve list entity tags where tag key contains user input 5431 # Example: 5432 # Request: 5433 # query { 5434 # 5435 # matchEntityTags(input: { tagKey: "test}) { 5436 # 5437 # records { 5438 # 5439 # tagKey 5440 # 5441 # tagValue 5442 # 5443 # } 5444 # 5445 # } 5446 # } 5447 # Response: 5448 # { 5449 # 5450 # "data": { 5451 # 5452 # "matchEntityTags": { 5453 # 5454 # "records": [ 5455 # 5456 # { 5457 # 5458 # "tagKey": "test-tag", 5459 # 5460 # "tagValue": "test-value" 5461 # 5462 # }, 5463 # 5464 # { 5465 # 5466 # "tagKey": "another-testtag", 5467 # 5468 # "tagValue": "" 5469 # 5470 # }, 5471 # 5472 # ] 5473 # 5474 # } 5475 # 5476 # } 5477 # } 5478 # 5479 # Arguments 5480 # input: User provided text and entity type input. 5481 # offset: Specify maximum number of results to retrieve in this 5482 # result. Page size. 5483 # limit: Specify maximum number of results to retrieve in this 5484 # result. 5485 MatchEntityTagInput!, : Int, : Int): MatchedEntityTagsList ( : 5486 5487 # Returns all custom dashboards created by user 5488 # Example: 5489 # Request: 5490 # query { 5491 # 5492 # customDashboards { 5493 # 5494 # records { 5495 # 5496 # id 5497 # 5498 # description 5499 # 5500 # hostAppId 5501 # 5502 # } 5503 # 5504 # } 5505 # } 5506 # Response: 5507 # { 5508 # 5509 # "data": { 5510 # 5511 # "customDashboards": { 5512 # 5513 # "records": [ 5514 # 5515 # { 5516 # 5517 # "id": "a20ae938-e827-4b0b-a62a-6c9af0b98cc9", 5518 # 5519 # "description": "example", 5520 # 5521 # "hostAppId": "80354999-d633-4595-9578-d82f59a5134f" 5522 # 5523 # } 5524 # 5525 # ] 5526 # 5527 # } 5528 # 5529 # } 5530 # } 5531 # 5532 # Arguments 5533 # offset: Provide an offset to skip to a certain element in the 5534 # result, for paging. 5535 # limit: Specify maximum number of results to retrieve in this 5536 # result. Page size. 5537 # hostAppId: Include only dashboards created by specific 5538 # host_app_id 5539 Int, : Int, : ID): CustomDashboardList ( : 5540 5541 # Returns custom dashboard by id 5542 # Example: 5543 # Request: 5544 # query { 5545 # 5546 # customDashboard(id: "a20ae938-e827-4b0b-a62a-6c9af0b98cc9") { 5547 # 5548 # hostAppId 5549 # 5550 # name 5551 # 5552 # } 5553 # } 5554 # Response: 5555 # { 5556 # 5557 # "data": { 5558 # 5559 # "customDashboard": { 5560 # 5561 # "hostAppId": "80354999-d633-4595-9578-d82f59a5134f", 5562 # 5563 # "name": "example" 5564 # 5565 # } 5566 # 5567 # } 5568 # } 5569 ID!): CustomDashboard ( : 5570 5571 # Gets engine usage for an organization based on their billing type. 5572 # Example: 5573 # Request: 5574 # query { 5575 # 5576 # getUsageByTaskType { 5577 # 5578 # totalDuration 5579 # 5580 # totalCost 5581 # 5582 # } 5583 # } 5584 # Response: 5585 # { 5586 # 5587 # "data": { 5588 # 5589 # "getUsageByTaskType": { 5590 # 5591 # "totalDuration": 0, 5592 # 5593 # "totalCost": "0" 5594 # 5595 # } 5596 # 5597 # } 5598 # } 5599 UsageByTaskType! : 5600 5601 # Retrives the specific Dataset 5602 # 5603 # Arguments 5604 # id: Supply the ID of the Dataset to retrieve 5605 ID!): Dataset ( : 5606 5607 # Retrieve list of Datasets 5608 # Example: 5609 # Request: 5610 # query { 5611 # 5612 # datasets(limit:2, filter: {operation:OR}) { 5613 # 5614 # records { 5615 # 5616 # datasetId 5617 # 5618 # name 5619 # 5620 # } 5621 # 5622 # } 5623 # } 5624 # Response: 5625 # { 5626 # 5627 # "data": { 5628 # 5629 # "datasets": { 5630 # 5631 # "records": [] 5632 # 5633 # } 5634 # 5635 # } 5636 # } 5637 # 5638 # Arguments 5639 # offset: Provide an offset to skip to a certain element in the 5640 # result, for paging. 5641 # limit: Specify maximum number of results to retrieve in this 5642 # result. Page size. 5643 # filter: Filters for Dataset attributes 5644 Int, : Int, : DatasetFilter): DatasetList ( : 5645 5646 # Arguments 5647 # datasetId: Supply the ID of the Dataset to retrieve 5648 # offset: Provide an offset to skip to a certain element in the 5649 # result, for paging. 5650 # limit: Specify maximum number of results to retrieve in this 5651 # result. Page size. 5652 # filter: Query to filter SDO. Supports operations such as and, 5653 # or, eq, gt, lt, etc. 5654 # TODO link to syntax documentation 5655 # orderBy: Order by 5656 ( 5657 ID!, : 5658 Int, : 5659 Int, : 5660 JSONData, : 5661 StructuredDataOrderBy!] : [ 5662 ): DatasetEntryList! 5663 5664 # Retrive list of Engine Replacement 5665 # Example: 5666 # Request: 5667 # query { 5668 # 5669 # taskReplacementEngines { 5670 # 5671 # records { 5672 # 5673 # sourceEngineId 5674 # 5675 # replacementEngineId 5676 # 5677 # } 5678 # 5679 # } 5680 # } 5681 # Response: 5682 # { 5683 # 5684 # "data": { 5685 # 5686 # "taskReplacementEngines": { 5687 # 5688 # "records": [ 5689 # 5690 # { 5691 # 5692 # "sourceEngineId": "1", 5693 # 5694 # "replacementEngineId": "2" 5695 # 5696 # } 5697 # 5698 # ] 5699 # 5700 # } 5701 # 5702 # } 5703 # } 5704 # 5705 # Arguments 5706 # organizationId: Only superadmin can get engine replacement of 5707 # other orgs 5708 # engineId: Filter by the source engineId 5709 # offset: Provide an offset to skip to a certain element in the 5710 # result, for paging. 5711 # limit: Specify maximum number of results to retrieve in this 5712 # result. Page size. 5713 ( 5714 ID, : 5715 ID, : 5716 Int, : 5717 Int : 5718 ): TaskReplacementEngineList 5719 5720 # Retrive Notification Mailboxes by list of mailboxIds 5721 # Example: 5722 # Request: 5723 # query { 5724 # 5725 # notificationMailboxes { 5726 # 5727 # id 5728 # 5729 # name 5730 # 5731 # } 5732 # } 5733 # Response: 5734 # { 5735 # 5736 # "data": { 5737 # 5738 # "notificationMailboxes": [ 5739 # 5740 # { 5741 # 5742 # "id": "6fda80b5-3d1a-4eb8-bd32-277be5104149", 5743 # 5744 # "name": "example" 5745 # 5746 # }, 5747 # 5748 # { 5749 # 5750 # "id": "d20e9f37-a887-41bb-aed0-3268884ecebc", 5751 # 5752 # "name": "Library training mailbox" 5753 # 5754 # }, 5755 # 5756 # { 5757 # 5758 # "id": "2d29533b-560e-4354-b794-84f823d33205", 5759 # 5760 # "name": "Library training mailbox" 5761 # 5762 # } 5763 # 5764 # ] 5765 # 5766 # } 5767 # } 5768 ID!]): [NotificationMailbox!] ( : [ 5769 5770 # Retrive Notification Templates 5771 # Example: 5772 # Request: 5773 # query { 5774 # 5775 # notificationTemplates(limit: 2) { 5776 # 5777 # records { 5778 # 5779 # id 5780 # 5781 # eventName 5782 # 5783 # } 5784 # 5785 # } 5786 # } 5787 # Response: 5788 # { 5789 # 5790 # "data": { 5791 # 5792 # "notificationTemplates": { 5793 # 5794 # "records": [ 5795 # 5796 # { 5797 # 5798 # "id": "3947b833-2be4-4415-8272-2cee62fbca23", 5799 # 5800 # "eventName": "example" 5801 # 5802 # } 5803 # 5804 # ] 5805 # 5806 # } 5807 # 5808 # } 5809 # } 5810 # 5811 # Arguments 5812 # ids: Get by array of ids 5813 # eventName: Get by eventName 5814 # eventType: Get by eventType 5815 # application: Get by application 5816 # mailboxId: Get by mailboxId 5817 # ownerOrganizationId: Only super-admin or orgless token can get 5818 # templates by ownerOrganizationId 5819 # offset: Provide an offset to skip to a certain element in the 5820 # result, for paging. 5821 # limit: Specify maximum number of results to retrieve in this 5822 # result. Page size. 5823 ( 5824 ID], : [ 5825 String, : 5826 String, : 5827 String, : 5828 ID, : 5829 ID, : 5830 Int, : 5831 Int : 5832 ): NotificationTemplateList 5833 5834 # Retrieve Notification Actions 5835 # Example: 5836 # Request: 5837 # query { 5838 # 5839 # notificationActions { 5840 # 5841 # records { 5842 # 5843 # id 5844 # 5845 # actionName 5846 # 5847 # } 5848 # 5849 # } 5850 # } 5851 # Response: 5852 # { 5853 # 5854 # "data": { 5855 # 5856 # "notificationActions": { 5857 # 5858 # "records": [ 5859 # 5860 # { 5861 # 5862 # "id": "866aad9c-9e68-4c33-b523-373bb332aea2", 5863 # 5864 # "actionName": "example" 5865 # 5866 # } 5867 # 5868 # ] 5869 # 5870 # } 5871 # 5872 # } 5873 # } 5874 # 5875 # Arguments 5876 # ids: Get by array of ids 5877 # eventName: Get by eventName 5878 # eventType: Get by eventType 5879 # application: Get by application 5880 # mailboxId: Get by mailboxId 5881 # ownerOrganizationId: Only super-admin or orgless token can get 5882 # templates by ownerOrganizationId 5883 # offset: Provide an offset to skip to a certain element in the 5884 # result, for paging. 5885 # limit: Specify maximum number of results to retrieve in this 5886 # result. Page size. 5887 ( 5888 ID], : [ 5889 String, : 5890 String, : 5891 String, : 5892 ID, : 5893 ID, : 5894 Int, : 5895 Int : 5896 ): NotificationActionList 5897 5898 # Retrieve Application user setting definitions 5899 # Example: 5900 # Request: 5901 # query { 5902 # 5903 # getUserSettingDefinitions(application: "80354999-d633-4595-9578-d82f59a5134f") { 5904 # 5905 # key 5906 # 5907 # value 5908 # 5909 # } 5910 # } 5911 # Response: 5912 # { 5913 # 5914 # "data": { 5915 # 5916 # "getUserSettingDefinitions": [ 5917 # 5918 # { 5919 # 5920 # "key": "example", 5921 # 5922 # "value": "example" 5923 # 5924 # } 5925 # 5926 # ] 5927 # 5928 # } 5929 # } 5930 # 5931 # Arguments 5932 # application: Specify the applicationId 5933 # key: Specify the key of user setting (optional) 5934 # organizationGuid: Specify the organizationGuid (require for 5935 # internal token) 5936 # This can be specified by superadmin to get user setting definitions of other 5937 # organization 5938 ( 5939 ID!, : 5940 String, : 5941 ID : 5942 ): [ApplicationSetting] 5943 5944 # Retrive User setting 5945 # Example: 5946 # Request: 5947 # query { 5948 # 5949 # getUserSettings { 5950 # 5951 # key 5952 # 5953 # applicationId 5954 # 5955 # } 5956 # } 5957 # Response: 5958 # { 5959 # 5960 # "data": { 5961 # 5962 # "getUserSettings": [ 5963 # 5964 # { 5965 # 5966 # "key": "example12", 5967 # 5968 # "applicationId": "80354999-d633-4595-9578-d82f59a5134f" 5969 # 5970 # } 5971 # 5972 # ] 5973 # 5974 # } 5975 # } 5976 # 5977 # Arguments 5978 # userId: Filter by userId (optional). 5979 # If it's not specified, default is current user 5980 # application: Filter by applicationId 5981 # keys: Filter by keys 5982 ID, : ID, : [String]): [UserSetting] ( : 5983 5984 # Example: 5985 # Request: 5986 # query { 5987 # 5988 # staticAppConfig { 5989 # 5990 # loginUrl 5991 # 5992 # apiRoot 5993 # 5994 # } 5995 # } 5996 # Response: 5997 # { 5998 # 5999 # "data": { 6000 # 6001 # "staticAppConfig": { 6002 # 6003 # "loginUrl": "https://login.veritone.com", 6004 # 6005 # "apiRoot": "https://api.veritone.com" 6006 # 6007 # } 6008 # 6009 # } 6010 # } 6011 StaticAppConfig! : 6012 6013 # Get OpenID Provider by id 6014 ID!): OpenIdProvider! ( : 6015 6016 # Get OpenID Provides 6017 # Example: 6018 # Request: 6019 # query { 6020 # 6021 # openIdProviders { 6022 # 6023 # records { 6024 # 6025 # id 6026 # 6027 # isGlobal 6028 # 6029 # websiteUrl 6030 # 6031 # } 6032 # 6033 # } 6034 # } 6035 # Response: 6036 # { 6037 # 6038 # "data": { 6039 # 6040 # "openIdProviders": { 6041 # 6042 # "records": [] 6043 # 6044 # } 6045 # 6046 # } 6047 # } 6048 # 6049 # Arguments 6050 # orgId: Filter Providers by organizationId. This is only used by 6051 # superadmin. 6052 # If filter with org-admin role, orgId is always the current user org. 6053 ( 6054 ID], : [ 6055 Boolean, : 6056 ID, : 6057 Int, : 6058 Int : 6059 ): OpenIdProviderList 6060 6061 # Arguments 6062 # orgId: This returns all packages that the Organization has 6063 # access to. 6064 # 6065 # ___Note: for Super-Admin use only.___ 6066 # resourceId: This returns packages that have the provided 6067 # resource linked to it 6068 # resourceAlias: This returns any packages have resources that 6069 # have the alias. 6070 # primaryResourceId: This returns packages that have the provided 6071 # resource as its primary resource 6072 # sourceOriginId: This returns the entire lineage of packages 6073 # that share the same sourceOriginId. 6074 # 6075 # This UUID is used to track a package's lineage. This UUID and versions is NOT 6076 # guaranteed to be a package ID and should not be used as such. 6077 # sourcePackageId: This returns any packages that immediately 6078 # derive from the provided ID. 6079 # 6080 # The sourcePackageId of a package refers to the package that it derived from, if 6081 # any. 6082 # For example, there is a lineage of packages that contain versions 1.0, 2.0, 3.0, 6083 # and 4.0. 6084 # If the ID of version 2.0 is provided, this filter will return the package 6085 # information for 6086 # only version 3.0. This is because version 3.0 is the immediate descendent of 6087 # version 2.0. 6088 # packageFilter: Fields to filter the results by. 6089 # distributionType: This returns packages of a specific 6090 # distribution type 6091 # distributionTypes: This returns packages of a list of 6092 # distribution types 6093 # status: This returns packages with a specific status 6094 # nameRegexp: name regexp pattern 6095 # owned: If true, return only packages owned by the calling org. 6096 # 6097 # If false, return all packages that the calling org has access to. 6098 # 6099 # The default behavior when `owned` is not provided assumes `false`. 6100 # 6101 # __Note__: Superadmin tokens are authorized to change the `orgId` field. If 6102 # provided, the above behavior will apply to `orgId` instead of the calling org. 6103 # includeDeleted: If true, result includes deleted packages 6104 # offset: Provide an offset to skip to a certain element in the 6105 # result, for paging. 6106 # limit: Specify maximum number of results to retrieve in this 6107 # result. Page size. 6108 ( 6109 ID, : 6110 ID!], : [ 6111 ID, : 6112 ID, : 6113 String, : 6114 ID, : 6115 ID, : 6116 ID, : 6117 PackageFilter, : 6118 EngineDistributionType, : 6119 EngineDistributionType!], : [ 6120 PackageStatus, : 6121 String, : 6122 Boolean, : 6123 Boolean, : 6124 Int, : 6125 Int : 6126 ): PackageList 6127 6128 # List existing package grants. 6129 # Either packageId or organizationId must be specified. 6130 # 6131 # The following examples assume that the caller is the owner of the Packages: 6132 # packageGrants(id: 123) - Show Grants for Package 123 6133 # packageGrants(organizationId: 12) - Show Grants for all Packages to Org 12 6134 # packageGrants(id: 123, organizationId: 12) Show Grants for Package 123 to Org 12 6135 # 6136 # Arguments 6137 # id: Package ID. If specified, show all the Grants for this 6138 # Package. 6139 # 6140 # If calling Org is owner of the Package, show all Grants. 6141 # 6142 # If calling Org is not owner of the Package, only show Grants for the Package to 6143 # the calling Org. 6144 # 6145 # If Super-Admin, show all Grants for the Package. 6146 # orgId: Show all Grants to the specified Org. 6147 # 6148 # If the input organizationId is different from the calling Org, this will show 6149 # Grants for Packages 6150 # that are owned by the calling Org to the specified Org. 6151 # 6152 # If the input organizationId is the same as the caller's Org, this will show 6153 # Grants for Packages 6154 # to the calling Org. 6155 # 6156 # If Super-Admin, show Grants for all Packages to the specified Org. 6157 # includeDeleted: If true, result includes deleted packages 6158 # offset: Provide an offset to skip to a certain element in the 6159 # result, for paging. 6160 # limit: Specify maximum number of results to retrieve in this 6161 # result. Page size. 6162 ( 6163 ID, : 6164 ID, : 6165 Boolean, : 6166 Int, : 6167 Int, : 6168 PackageGrantFilter : 6169 ): PackageGrantList 6170 6171 # Retrieve the basic user information. 6172 # The caller and the queried user are required to be members of the same 6173 # organization, 6174 # unless the caller is superadmin user. 6175 # Example: 6176 # Request: 6177 # query { 6178 # 6179 # basicUserInfo(id: "267de7e1-efb2-444a-a524-210328b78503") { 6180 # 6181 # id 6182 # 6183 # name 6184 # 6185 # firstName 6186 # 6187 # lastName 6188 # 6189 # email 6190 # 6191 # imageUrl 6192 # 6193 # } 6194 # } 6195 # Response: 6196 # { 6197 # 6198 # "data": { 6199 # 6200 # "basicUserInfo": { 6201 # 6202 # "id": "267de7e1-efb2-444a-a524-210328b78503", 6203 # 6204 # "name": "username", 6205 # 6206 # "firstName": "first", 6207 # 6208 # "lastName": "last", 6209 # 6210 # "email": "email@test.com", 6211 # 6212 # "imageUrl": null 6213 # 6214 # } 6215 # 6216 # } 6217 # } 6218 # 6219 # Arguments 6220 # id: The user ID. 6221 # A user ID is a string in UUID format. 6222 ID!): BasicUserInfo ( : 6223 6224 ApiTokenInfo]! : [ 6225 6226 # Gets the most up to date package linked to this automate flow 6227 # 6228 # Arguments 6229 # engineId: Engine Id for the automate flow. 6230 ID!): Package ( : 6231 6232 # Retrieve applicationViewers 6233 # Example: 6234 # Request: 6235 # query { 6236 # applicationViewers(limit:2) { 6237 # records{ 6238 # id 6239 # name 6240 # } 6241 # } 6242 # } 6243 # Response: 6244 # { 6245 # "data": { 6246 # "viewers": { 6247 # "records": [ 6248 # { 6249 # "id": "2a1a1b58-6983-4002-b9ed-7b7f325f621a", 6250 # "name": "Viewer 1" 6251 # }, 6252 # { 6253 # "id": "4a2a1b58-6993-4002-b9ed-7b7f325f662c", 6254 # "name": "Viewer 2" 6255 # } 6256 # ] 6257 # } 6258 # } 6259 # } 6260 # 6261 # Arguments 6262 # ids: Provide an ids to retrieve specific viewers. 6263 # offset: Specify maximum number of results to retrieve in this 6264 # result. Page size. 6265 # limit: Specify maximum number of results to retrieve in this 6266 # result. 6267 # orderBy: Provide a list of ApplicationViewerSortField to sort 6268 # by. 6269 ( 6270 ID!], : [ 6271 Int, : 6272 Int, : 6273 ApplicationViewerSortField : 6274 ): ApplicationViewerList 6275 6276 }
link Required by
This element is not required by anyone