github.com/emreu/go-swagger@v0.22.1/fixtures/expansion/clickmeter.yaml (about) 1 swagger: '2.0' 2 schemes: 3 - http 4 - https 5 host: 'apiv2.clickmeter.com:80' 6 info: 7 contact: 8 email: api@clickmeter.com 9 name: Api Support 10 url: 'http://www.clickmeter.com/api' 11 description: Api dashboard for ClickMeter API 12 title: ClickMeter 13 version: v2 14 x-logo: 15 url: 'https://s3.amazonaws.com/clickmeter.com/Web/static/cmlogo.svg' 16 x-origin: 17 format: swagger 18 url: 'http://api.v2.clickmeter.com.s3.amazonaws.com/docs/api-docs-v2.json' 19 version: '2.0' 20 x-providerName: clickmeter.com 21 securityDefinitions: 22 api_key: 23 description: API Key Authentication 24 in: header 25 name: X-Clickmeter-AuthKey 26 type: apiKey 27 security: 28 - api_key: [] 29 paths: 30 /account: 31 get: 32 consumes: [] 33 deprecated: false 34 produces: 35 - application/json 36 - text/json 37 - application/xml 38 - text/xml 39 responses: 40 '200': 41 description: '' 42 schema: 43 $ref: '#/definitions/Api.Core.Dto.Accounting.User' 44 '401': 45 description: Unauthorized 46 '500': 47 description: Internal Server Error 48 summary: Retrieve current account data 49 tags: 50 - Account 51 post: 52 consumes: 53 - application/json 54 - text/json 55 - application/xml 56 - text/xml 57 - application/x-www-form-urlencoded 58 deprecated: false 59 parameters: 60 - in: body 61 name: value 62 required: true 63 schema: 64 $ref: '#/definitions/Api.Core.Dto.Accounting.User' 65 produces: 66 - application/json 67 - text/json 68 - application/xml 69 - text/xml 70 responses: 71 '200': 72 description: '' 73 schema: 74 $ref: '#/definitions/Api.Core.Dto.Accounting.User' 75 '401': 76 description: Unauthorized 77 '500': 78 description: Internal Server Error 79 summary: Update current account data 80 tags: 81 - Account 82 /account/domainwhitelist: 83 get: 84 consumes: [] 85 deprecated: false 86 parameters: 87 - description: Offset where to start from 88 format: int32 89 in: query 90 minLength: 0 91 name: offset 92 required: false 93 type: integer 94 - description: Limit results to this number 95 format: int32 96 in: query 97 maxLength: 0 98 minLength: 0 99 name: limit 100 required: false 101 type: integer 102 produces: 103 - application/json 104 - text/json 105 responses: 106 '200': 107 description: '' 108 schema: 109 $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Accounting.DomainWhitelistEntry]' 110 '401': 111 description: Unauthorized 112 '500': 113 description: Internal Server Error 114 summary: Retrieve list of a domains allowed to redirect in DDU mode 115 tags: 116 - Account 117 post: 118 consumes: 119 - application/json 120 - text/json 121 - application/xml 122 - text/xml 123 - application/x-www-form-urlencoded 124 deprecated: false 125 parameters: 126 - description: The entry to add 127 in: body 128 name: value 129 required: true 130 schema: 131 $ref: '#/definitions/Api.Core.Dto.Accounting.DomainWhitelistEntry' 132 produces: 133 - application/json 134 - text/json 135 - application/xml 136 - text/xml 137 responses: 138 '200': 139 description: '' 140 schema: 141 $ref: '#/definitions/Api.Core.Dto.Accounting.DomainWhitelistEntry' 142 '401': 143 description: Unauthorized 144 '500': 145 description: Internal Server Error 146 summary: Create an domain entry 147 tags: 148 - Account 149 '/account/domainwhitelist/{whitelistId}': 150 delete: 151 consumes: [] 152 deprecated: false 153 parameters: 154 - description: The id of the domain to delete 155 in: path 156 name: whitelistId 157 required: true 158 type: string 159 produces: 160 - application/json 161 - text/json 162 - application/xml 163 - text/xml 164 responses: 165 '200': 166 description: '' 167 schema: 168 $ref: '#/definitions/Api.Core.Dto.Accounting.DomainWhitelistEntry' 169 '401': 170 description: Unauthorized 171 '500': 172 description: Internal Server Error 173 summary: Delete an domain entry 174 tags: 175 - Account 176 /account/guests: 177 get: 178 consumes: [] 179 deprecated: false 180 parameters: 181 - description: Offset where to start from 182 format: int32 183 in: query 184 minLength: 0 185 name: offset 186 required: false 187 type: integer 188 - description: Limit results to this number 189 format: int32 190 in: query 191 maxLength: 0 192 minLength: 0 193 name: limit 194 required: false 195 type: integer 196 - description: Field to sort by 197 in: query 198 name: sortBy 199 required: false 200 type: string 201 - description: 'Direction of sort "asc" or "desc"' 202 enum: 203 - asc 204 - desc 205 in: query 206 name: sortDirection 207 required: false 208 type: string 209 - description: Filter fields by this pattern 210 in: query 211 name: textSearch 212 required: false 213 type: string 214 produces: 215 - application/json 216 - text/json 217 responses: 218 '200': 219 description: '' 220 schema: 221 $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]' 222 '401': 223 description: Unauthorized 224 '500': 225 description: Internal Server Error 226 summary: Retrieve list of a guest 227 tags: 228 - Account 229 post: 230 consumes: 231 - application/json 232 - text/json 233 - application/xml 234 - text/xml 235 - application/x-www-form-urlencoded 236 deprecated: false 237 parameters: 238 - description: Guest object to create 239 in: body 240 name: value 241 required: true 242 schema: 243 $ref: '#/definitions/Api.Core.Dto.Accounting.Guest' 244 produces: 245 - application/json 246 - text/json 247 - application/xml 248 - text/xml 249 responses: 250 '200': 251 description: '' 252 schema: 253 $ref: '#/definitions/Api.Core.Dto.Accounting.Guest' 254 '401': 255 description: Unauthorized 256 '500': 257 description: Internal Server Error 258 summary: Create a guest 259 tags: 260 - Account 261 /account/guests/count: 262 get: 263 consumes: [] 264 deprecated: false 265 parameters: 266 - description: Filter fields by this pattern 267 in: query 268 name: textSearch 269 required: false 270 type: string 271 produces: 272 - application/json 273 - text/json 274 - application/xml 275 - text/xml 276 responses: 277 '200': 278 description: '' 279 schema: 280 $ref: '#/definitions/Api.Core.Responses.CountResponce' 281 '401': 282 description: Unauthorized 283 '500': 284 description: Internal Server Error 285 summary: Retrieve count of guests 286 tags: 287 - Account 288 '/account/guests/{guestId}': 289 delete: 290 consumes: [] 291 deprecated: false 292 parameters: 293 - description: Id of the guest 294 format: int64 295 in: path 296 name: guestId 297 required: true 298 type: integer 299 produces: 300 - application/json 301 - text/json 302 - application/xml 303 - text/xml 304 responses: 305 '200': 306 description: '' 307 schema: 308 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 309 '401': 310 description: Unauthorized 311 '500': 312 description: Internal Server Error 313 summary: Delete a guest 314 tags: 315 - Account 316 get: 317 consumes: [] 318 deprecated: false 319 parameters: 320 - description: Id of the guest 321 format: int64 322 in: path 323 name: guestId 324 required: true 325 type: integer 326 produces: 327 - application/json 328 - text/json 329 - application/xml 330 - text/xml 331 responses: 332 '200': 333 description: '' 334 schema: 335 $ref: '#/definitions/Api.Core.Dto.Accounting.Guest' 336 '401': 337 description: Unauthorized 338 '500': 339 description: Internal Server Error 340 summary: Retrieve a guest 341 tags: 342 - Account 343 post: 344 consumes: 345 - application/json 346 - text/json 347 - application/xml 348 - text/xml 349 - application/x-www-form-urlencoded 350 deprecated: false 351 parameters: 352 - description: Id of the guest 353 format: int64 354 in: path 355 name: guestId 356 required: true 357 type: integer 358 - description: Guest object with field updated 359 in: body 360 name: value 361 required: true 362 schema: 363 $ref: '#/definitions/Api.Core.Dto.Accounting.Guest' 364 produces: 365 - application/json 366 - text/json 367 - application/xml 368 - text/xml 369 responses: 370 '200': 371 description: '' 372 schema: 373 $ref: '#/definitions/Api.Core.Dto.Accounting.Guest' 374 '401': 375 description: Unauthorized 376 '500': 377 description: Internal Server Error 378 summary: Update a guest 379 tags: 380 - Account 381 '/account/guests/{guestId}/permissions': 382 get: 383 consumes: [] 384 deprecated: false 385 parameters: 386 - description: Id of the guest 387 format: int64 388 in: path 389 name: guestId 390 required: true 391 type: integer 392 - description: 'Can be "datapoint" or "group"' 393 enum: 394 - datapoint 395 - group 396 in: query 397 name: entityType 398 required: false 399 type: string 400 - description: Offset where to start from 401 format: int32 402 in: query 403 minLength: 0 404 name: offset 405 required: false 406 type: integer 407 - description: Limit results to this number 408 format: int32 409 in: query 410 maxLength: 0 411 minLength: 0 412 name: limit 413 required: false 414 type: integer 415 - description: 'Can be "w" or "r"' 416 enum: 417 - r 418 - w 419 in: query 420 name: type 421 required: false 422 type: string 423 - description: Optional id of the datapoint/group entity to filter by 424 format: int64 425 in: query 426 name: entityId 427 required: false 428 type: integer 429 produces: 430 - application/json 431 - text/json 432 responses: 433 '200': 434 description: '' 435 schema: 436 $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Grants.Grant]' 437 '401': 438 description: Unauthorized 439 '500': 440 description: Internal Server Error 441 summary: Retrieve permissions for a guest 442 tags: 443 - Account 444 '/account/guests/{guestId}/permissions/count': 445 get: 446 consumes: [] 447 deprecated: false 448 parameters: 449 - description: Id of the guest 450 format: int64 451 in: path 452 name: guestId 453 required: true 454 type: integer 455 - description: 'Can be "datapoint" or "group"' 456 enum: 457 - datapoint 458 - group 459 in: query 460 name: entityType 461 required: false 462 type: string 463 - description: 'Can be "w" or "r"' 464 enum: 465 - r 466 - w 467 in: query 468 name: type 469 required: false 470 type: string 471 - description: Optional id of the datapoint/group entity to filter by 472 format: int64 473 in: query 474 name: entityId 475 required: false 476 type: integer 477 produces: 478 - application/json 479 - text/json 480 - application/xml 481 - text/xml 482 responses: 483 '200': 484 description: '' 485 schema: 486 $ref: '#/definitions/Api.Core.Responses.CountResponce' 487 '401': 488 description: Unauthorized 489 '500': 490 description: Internal Server Error 491 summary: Retrieve count of the permissions for a guest 492 tags: 493 - Account 494 '/account/guests/{guestId}/{type}/permissions/patch': 495 post: 496 consumes: 497 - application/json 498 - text/json 499 - application/xml 500 - text/xml 501 - application/x-www-form-urlencoded 502 deprecated: false 503 parameters: 504 - description: Id of the guest 505 format: int64 506 in: path 507 name: guestId 508 required: true 509 type: integer 510 - description: 'Can be "datapoint" or "group"' 511 enum: 512 - datapoint 513 - group 514 in: path 515 name: type 516 required: true 517 type: string 518 - description: The patch permission request 519 in: body 520 name: body 521 required: true 522 schema: 523 $ref: '#/definitions/Api.Core.Requests.PermissionPatchRequest' 524 produces: 525 - application/json 526 - text/json 527 - application/xml 528 - text/xml 529 responses: 530 '200': 531 description: '' 532 schema: 533 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 534 '401': 535 description: Unauthorized 536 '500': 537 description: Internal Server Error 538 summary: Change the permission on a shared object 539 tags: 540 - Account 541 put: 542 consumes: 543 - application/json 544 - text/json 545 - application/xml 546 - text/xml 547 - application/x-www-form-urlencoded 548 deprecated: false 549 parameters: 550 - description: Id of the guest 551 format: int64 552 in: path 553 name: guestId 554 required: true 555 type: integer 556 - description: 'Can be "datapoint" or "group"' 557 enum: 558 - datapoint 559 - group 560 in: path 561 name: type 562 required: true 563 type: string 564 - description: The patch permission request 565 in: body 566 name: body 567 required: true 568 schema: 569 $ref: '#/definitions/Api.Core.Requests.PermissionPatchRequest' 570 produces: 571 - application/json 572 - text/json 573 - application/xml 574 - text/xml 575 responses: 576 '200': 577 description: '' 578 schema: 579 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 580 '401': 581 description: Unauthorized 582 '500': 583 description: Internal Server Error 584 summary: Change the permission on a shared object 585 tags: 586 - Account 587 /account/ipblacklist: 588 get: 589 consumes: [] 590 deprecated: false 591 parameters: 592 - description: Offset where to start from 593 format: int32 594 in: query 595 minLength: 0 596 name: offset 597 required: false 598 type: integer 599 - description: Limit results to this number 600 format: int32 601 in: query 602 maxLength: 0 603 minLength: 0 604 name: limit 605 required: false 606 type: integer 607 produces: 608 - application/json 609 - text/json 610 responses: 611 '200': 612 description: '' 613 schema: 614 $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Accounting.IpBlacklistEntry]' 615 '401': 616 description: Unauthorized 617 '500': 618 description: Internal Server Error 619 summary: Retrieve list of a ip to exclude from event tracking 620 tags: 621 - Account 622 post: 623 consumes: 624 - application/json 625 - text/json 626 - application/xml 627 - text/xml 628 - application/x-www-form-urlencoded 629 deprecated: false 630 parameters: 631 - description: The entry to add 632 in: body 633 name: value 634 required: true 635 schema: 636 $ref: '#/definitions/Api.Core.Dto.Accounting.IpBlacklistEntry' 637 produces: 638 - application/json 639 - text/json 640 - application/xml 641 - text/xml 642 responses: 643 '200': 644 description: '' 645 schema: 646 $ref: '#/definitions/Api.Core.Dto.Accounting.IpBlacklistEntry' 647 '401': 648 description: Unauthorized 649 '500': 650 description: Internal Server Error 651 summary: Create an ip blacklist entry 652 tags: 653 - Account 654 '/account/ipblacklist/{blacklistId}': 655 delete: 656 consumes: [] 657 deprecated: false 658 parameters: 659 - description: The id of the ip to delete 660 in: path 661 name: blacklistId 662 required: true 663 type: string 664 produces: 665 - application/json 666 - text/json 667 - application/xml 668 - text/xml 669 responses: 670 '200': 671 description: '' 672 schema: 673 $ref: '#/definitions/Api.Core.Dto.Accounting.IpBlacklistEntry' 674 '401': 675 description: Unauthorized 676 '500': 677 description: Internal Server Error 678 summary: Delete an ip blacklist entry 679 tags: 680 - Account 681 /account/plan: 682 get: 683 consumes: [] 684 deprecated: false 685 produces: 686 - application/json 687 - text/json 688 - application/xml 689 - text/xml 690 responses: 691 '200': 692 description: '' 693 schema: 694 $ref: '#/definitions/Api.Core.Dto.Accounting.Plan' 695 '401': 696 description: Unauthorized 697 '500': 698 description: Internal Server Error 699 summary: Retrieve current account plan 700 tags: 701 - Account 702 /aggregated: 703 get: 704 consumes: [] 705 deprecated: false 706 parameters: 707 - description: Timeframe of the request. See list at $timeframeList 708 enum: 709 - today 710 - yesterday 711 - last7 712 - last30 713 - lastmonth 714 - currentmonth 715 - previousmonth 716 - last90 717 - last120 718 - last180 719 - last12months 720 - lastyear 721 - currentyear 722 - beginning 723 - custom 724 in: query 725 name: timeFrame 726 required: true 727 type: string 728 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 729 in: query 730 name: fromDay 731 required: false 732 type: string 733 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 734 in: query 735 name: toDay 736 required: false 737 type: string 738 - description: 'If using "yesterday" or "today" timeframe you can ask for the hourly detail' 739 in: query 740 name: hourly 741 required: false 742 type: boolean 743 - description: '' 744 in: query 745 name: onlyFavorites 746 required: false 747 type: string 748 produces: 749 - application/json 750 - text/json 751 responses: 752 '200': 753 description: '' 754 schema: 755 $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedResult' 756 '401': 757 description: Unauthorized 758 '500': 759 description: Internal Server Error 760 summary: Retrieve statistics about this customer for a timeframe 761 tags: 762 - Aggregated 763 /aggregated/list: 764 get: 765 consumes: [] 766 deprecated: false 767 parameters: 768 - description: Timeframe of the request. See list at $timeframeList 769 enum: 770 - today 771 - yesterday 772 - last7 773 - last30 774 - lastmonth 775 - currentmonth 776 - previousmonth 777 - last90 778 - last120 779 - last180 780 - last12months 781 - lastyear 782 - currentyear 783 - beginning 784 - custom 785 in: query 786 name: timeFrame 787 required: true 788 type: string 789 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 790 in: query 791 name: fromDay 792 required: false 793 type: string 794 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 795 in: query 796 name: toDay 797 required: false 798 type: string 799 - description: 'The temporal entity you want to group by ("week"/"month"). If unspecified is "day".' 800 enum: 801 - week 802 - month 803 in: query 804 name: groupBy 805 required: false 806 type: string 807 produces: 808 - application/json 809 - text/json 810 responses: 811 '200': 812 description: '' 813 schema: 814 $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Aggregated.AggregatedResult]' 815 '401': 816 description: Unauthorized 817 '500': 818 description: Internal Server Error 819 summary: Retrieve statistics about this customer for a timeframe grouped by some temporal entity (day/week/month) 820 tags: 821 - Aggregated 822 /aggregated/summary/conversions: 823 get: 824 consumes: [] 825 deprecated: false 826 parameters: 827 - description: Timeframe of the request. See list at $timeframeList 828 enum: 829 - today 830 - yesterday 831 - last7 832 - last30 833 - lastmonth 834 - currentmonth 835 - previousmonth 836 - last90 837 - last120 838 - last180 839 - last12months 840 - lastyear 841 - currentyear 842 - beginning 843 - custom 844 in: query 845 name: timeFrame 846 required: true 847 type: string 848 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 849 in: query 850 name: fromDay 851 required: false 852 type: string 853 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 854 in: query 855 name: toDay 856 required: false 857 type: string 858 - description: 'Status of conversion ("deleted"/"active")' 859 enum: 860 - deleted 861 - active 862 in: query 863 name: status 864 required: false 865 type: string 866 - description: Field to sort by 867 in: query 868 name: sortBy 869 required: false 870 type: string 871 - description: 'Direction of sort "asc" or "desc"' 872 enum: 873 - asc 874 - desc 875 in: query 876 name: sortDirection 877 required: false 878 type: string 879 - description: Offset where to start from 880 format: int32 881 in: query 882 minLength: 0 883 name: offset 884 required: false 885 type: integer 886 - description: Limit results to this number 887 format: int32 888 in: query 889 maxLength: 0 890 minLength: 0 891 name: limit 892 required: false 893 type: integer 894 - description: Filter fields by this pattern 895 in: query 896 name: textSearch 897 required: false 898 type: string 899 produces: 900 - application/json 901 - text/json 902 responses: 903 '200': 904 description: '' 905 schema: 906 $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedSummaryResult' 907 '401': 908 description: Unauthorized 909 '500': 910 description: Internal Server Error 911 summary: Retrieve statistics about a subset of conversions for a timeframe with conversions data 912 tags: 913 - Aggregated 914 /aggregated/summary/datapoints: 915 get: 916 consumes: [] 917 deprecated: false 918 parameters: 919 - description: Timeframe of the request. See list at $timeframeList 920 enum: 921 - today 922 - yesterday 923 - last7 924 - last30 925 - lastmonth 926 - currentmonth 927 - previousmonth 928 - last90 929 - last120 930 - last180 931 - last12months 932 - lastyear 933 - currentyear 934 - beginning 935 - custom 936 in: query 937 name: timeFrame 938 required: true 939 type: string 940 - description: 'Type of datapoint ("tl"/"tp")' 941 enum: 942 - tp 943 - tl 944 in: query 945 name: type 946 required: true 947 type: string 948 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 949 in: query 950 name: fromDay 951 required: false 952 type: string 953 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 954 in: query 955 name: toDay 956 required: false 957 type: string 958 - description: 'Status of datapoint ("deleted"/"active"/"paused"/"spam")' 959 enum: 960 - deleted 961 - active 962 - paused 963 - spam 964 in: query 965 name: status 966 required: false 967 type: string 968 - description: A comma separated list of tags you want to filter with. 969 in: query 970 name: tag 971 required: false 972 type: string 973 - description: Is the datapoint marked as favourite 974 in: query 975 name: favourite 976 required: false 977 type: boolean 978 - description: Field to sort by 979 in: query 980 name: sortBy 981 required: false 982 type: string 983 - description: 'Direction of sort "asc" or "desc"' 984 enum: 985 - asc 986 - desc 987 in: query 988 name: sortDirection 989 required: false 990 type: string 991 - description: Offset where to start from 992 format: int32 993 in: query 994 minLength: 0 995 name: offset 996 required: false 997 type: integer 998 - description: Limit results to this number 999 format: int32 1000 in: query 1001 maxLength: 0 1002 minLength: 0 1003 name: limit 1004 required: false 1005 type: integer 1006 - description: Filter by this group id 1007 format: int64 1008 in: query 1009 name: groupId 1010 required: false 1011 type: integer 1012 - description: Filter fields by this pattern 1013 in: query 1014 name: textSearch 1015 required: false 1016 type: string 1017 produces: 1018 - application/json 1019 - text/json 1020 responses: 1021 '200': 1022 description: '' 1023 schema: 1024 $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedSummaryResult' 1025 '401': 1026 description: Unauthorized 1027 '500': 1028 description: Internal Server Error 1029 summary: Retrieve statistics about a subset of datapoints for a timeframe with datapoints data 1030 tags: 1031 - Aggregated 1032 /aggregated/summary/groups: 1033 get: 1034 consumes: [] 1035 deprecated: false 1036 parameters: 1037 - description: Timeframe of the request. See list at $timeframeList 1038 enum: 1039 - today 1040 - yesterday 1041 - last7 1042 - last30 1043 - lastmonth 1044 - currentmonth 1045 - previousmonth 1046 - last90 1047 - last120 1048 - last180 1049 - last12months 1050 - lastyear 1051 - currentyear 1052 - beginning 1053 - custom 1054 in: query 1055 name: timeFrame 1056 required: true 1057 type: string 1058 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 1059 in: query 1060 name: fromDay 1061 required: false 1062 type: string 1063 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 1064 in: query 1065 name: toDay 1066 required: false 1067 type: string 1068 - description: 'Status of group ("deleted"/"active")' 1069 enum: 1070 - deleted 1071 - active 1072 in: query 1073 name: status 1074 required: false 1075 type: string 1076 - description: A comma separated list of tags you want to filter with. 1077 in: query 1078 name: tag 1079 required: false 1080 type: string 1081 - description: Is the group marked as favourite 1082 in: query 1083 name: favourite 1084 required: false 1085 type: boolean 1086 - description: Field to sort by 1087 in: query 1088 name: sortBy 1089 required: false 1090 type: string 1091 - description: 'Direction of sort "asc" or "desc"' 1092 enum: 1093 - asc 1094 - desc 1095 in: query 1096 name: sortDirection 1097 required: false 1098 type: string 1099 - description: Offset where to start from 1100 format: int32 1101 in: query 1102 minLength: 0 1103 name: offset 1104 required: false 1105 type: integer 1106 - description: Limit results to this number 1107 format: int32 1108 in: query 1109 maxLength: 0 1110 minLength: 0 1111 name: limit 1112 required: false 1113 type: integer 1114 - description: Filter fields by this pattern 1115 in: query 1116 name: textSearch 1117 required: false 1118 type: string 1119 produces: 1120 - application/json 1121 - text/json 1122 responses: 1123 '200': 1124 description: '' 1125 schema: 1126 $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedSummaryResult' 1127 '401': 1128 description: Unauthorized 1129 '500': 1130 description: Internal Server Error 1131 summary: Retrieve statistics about a subset of groups for a timeframe with groups data 1132 tags: 1133 - Aggregated 1134 /clickstream: 1135 get: 1136 consumes: [] 1137 deprecated: false 1138 parameters: 1139 - description: 'Filter by this group id (mutually exclusive with "datapoint" and "conversion")' 1140 format: int64 1141 in: query 1142 name: group 1143 required: false 1144 type: integer 1145 - description: 'Filter by this datapoint id (mutually exclusive with "group" and "conversion")' 1146 format: int64 1147 in: query 1148 name: datapoint 1149 required: false 1150 type: integer 1151 - description: 'Filter by this conversion id (mutually exclusive with "datapoint" and "group")' 1152 format: int64 1153 in: query 1154 name: conversion 1155 required: false 1156 type: integer 1157 - default: 50 1158 description: Limit results to this number 1159 format: int32 1160 in: query 1161 name: pageSize 1162 required: false 1163 type: integer 1164 - description: 'Filter event type ("spiders"/"uniques"/"nonuniques"/"conversions")' 1165 enum: 1166 - '' 1167 - spiders 1168 - uniques 1169 - nonuniques 1170 - conversions 1171 in: query 1172 name: filter 1173 required: false 1174 type: string 1175 produces: 1176 - application/json 1177 - text/json 1178 responses: 1179 '200': 1180 description: '' 1181 schema: 1182 $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Dto.ClickStream.Hit]' 1183 '401': 1184 description: Unauthorized 1185 '500': 1186 description: Internal Server Error 1187 summary: Retrieve the latest list of events of this account. Limited to last 100. 1188 tags: 1189 - ClickStream 1190 /conversions: 1191 get: 1192 consumes: [] 1193 deprecated: false 1194 parameters: 1195 - description: Offset where to start from 1196 format: int32 1197 in: query 1198 minLength: 0 1199 name: offset 1200 required: false 1201 type: integer 1202 - description: Limit results to this number 1203 format: int32 1204 in: query 1205 maxLength: 0 1206 minLength: 0 1207 name: limit 1208 required: false 1209 type: integer 1210 - description: 'Status of conversion ("deleted"/"active")' 1211 enum: 1212 - deleted 1213 - active 1214 in: query 1215 name: status 1216 required: false 1217 type: string 1218 - description: Filter fields by this pattern 1219 in: query 1220 name: textSearch 1221 required: false 1222 type: string 1223 - description: Exclude conversions created before this date (YYYYMMDD) 1224 in: query 1225 name: createdAfter 1226 required: false 1227 type: string 1228 - description: Exclude conversions created after this date (YYYYMMDD) 1229 in: query 1230 name: createdBefore 1231 required: false 1232 type: string 1233 produces: 1234 - application/json 1235 - text/json 1236 responses: 1237 '200': 1238 description: '' 1239 schema: 1240 $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]' 1241 '401': 1242 description: Unauthorized 1243 '500': 1244 description: Internal Server Error 1245 summary: Retrieve a list of conversions 1246 tags: 1247 - Conversions 1248 post: 1249 consumes: 1250 - application/json 1251 - text/json 1252 - application/xml 1253 - text/xml 1254 - application/x-www-form-urlencoded 1255 deprecated: false 1256 parameters: 1257 - description: The body of the conversion 1258 in: body 1259 name: value 1260 required: true 1261 schema: 1262 $ref: '#/definitions/Api.Core.Dto.Conversions.Conversion' 1263 produces: 1264 - application/json 1265 - text/json 1266 - application/xml 1267 - text/xml 1268 responses: 1269 '200': 1270 description: '' 1271 schema: 1272 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 1273 '401': 1274 description: Unauthorized 1275 '404': 1276 description: Not found 1277 '500': 1278 description: Internal Server Error 1279 summary: Create a conversion 1280 tags: 1281 - Conversions 1282 /conversions/aggregated/list: 1283 get: 1284 consumes: [] 1285 deprecated: false 1286 parameters: 1287 - description: Timeframe of the request. See list at $timeframeList 1288 enum: 1289 - today 1290 - yesterday 1291 - last7 1292 - last30 1293 - lastmonth 1294 - currentmonth 1295 - previousmonth 1296 - last90 1297 - last120 1298 - last180 1299 - last12months 1300 - lastyear 1301 - currentyear 1302 - beginning 1303 - custom 1304 in: query 1305 name: timeFrame 1306 required: true 1307 type: string 1308 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 1309 in: query 1310 name: fromDay 1311 required: false 1312 type: string 1313 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 1314 in: query 1315 name: toDay 1316 required: false 1317 type: string 1318 - description: 'Status of conversion ("deleted"/"active")' 1319 enum: 1320 - deleted 1321 - active 1322 in: query 1323 name: status 1324 required: false 1325 type: string 1326 - description: 'The temporal entity you want to group by ("week"/"month"). If unspecified is "day".' 1327 enum: 1328 - week 1329 - month 1330 in: query 1331 name: groupBy 1332 required: false 1333 type: string 1334 produces: 1335 - application/json 1336 - text/json 1337 responses: 1338 '200': 1339 description: '' 1340 schema: 1341 $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Aggregated.AggregatedResult]' 1342 '401': 1343 description: Unauthorized 1344 '500': 1345 description: Internal Server Error 1346 summary: Retrieve statistics about this customer for a timeframe related to a subset of conversions grouped by some temporal entity (day/week/month) 1347 tags: 1348 - Conversions 1349 /conversions/count: 1350 get: 1351 consumes: [] 1352 deprecated: false 1353 parameters: 1354 - description: 'Status of conversion ("deleted"/"active")' 1355 enum: 1356 - deleted 1357 - active 1358 in: query 1359 name: status 1360 required: false 1361 type: string 1362 - description: Filter fields by this pattern 1363 in: query 1364 name: textSearch 1365 required: false 1366 type: string 1367 - description: Exclude conversions created before this date (YYYYMMDD) 1368 in: query 1369 name: createdAfter 1370 required: false 1371 type: string 1372 - description: Exclude conversions created after this date (YYYYMMDD) 1373 in: query 1374 name: createdBefore 1375 required: false 1376 type: string 1377 produces: 1378 - application/json 1379 - text/json 1380 - application/xml 1381 - text/xml 1382 responses: 1383 '200': 1384 description: '' 1385 schema: 1386 $ref: '#/definitions/Api.Core.Responses.CountResponce' 1387 '401': 1388 description: Unauthorized 1389 '500': 1390 description: Internal Server Error 1391 summary: Retrieve a count of conversions 1392 tags: 1393 - Conversions 1394 '/conversions/{conversionId}': 1395 delete: 1396 consumes: [] 1397 deprecated: false 1398 parameters: 1399 - description: Id of the conversion 1400 format: int64 1401 in: path 1402 name: conversionId 1403 required: true 1404 type: integer 1405 produces: 1406 - application/json 1407 - text/json 1408 - application/xml 1409 - text/xml 1410 responses: 1411 '200': 1412 description: '' 1413 schema: 1414 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 1415 '401': 1416 description: Unauthorized 1417 '404': 1418 description: Not found 1419 '500': 1420 description: Internal Server Error 1421 summary: Delete conversion specified by id 1422 tags: 1423 - Conversions 1424 get: 1425 consumes: [] 1426 deprecated: false 1427 parameters: 1428 - description: Id of the conversion 1429 format: int64 1430 in: path 1431 name: conversionId 1432 required: true 1433 type: integer 1434 produces: 1435 - application/json 1436 - text/json 1437 - application/xml 1438 - text/xml 1439 responses: 1440 '200': 1441 description: '' 1442 schema: 1443 $ref: '#/definitions/Api.Core.Dto.Conversions.Conversion' 1444 '401': 1445 description: Unauthorized 1446 '404': 1447 description: Not found 1448 '500': 1449 description: Internal Server Error 1450 summary: Retrieve conversion specified by id 1451 tags: 1452 - Conversions 1453 post: 1454 consumes: 1455 - application/json 1456 - text/json 1457 - application/xml 1458 - text/xml 1459 - application/x-www-form-urlencoded 1460 deprecated: false 1461 parameters: 1462 - description: Id of the conversion 1463 format: int64 1464 in: path 1465 name: conversionId 1466 required: true 1467 type: integer 1468 - description: Updated body of the conversion 1469 in: body 1470 name: value 1471 required: true 1472 schema: 1473 $ref: '#/definitions/Api.Core.Dto.Conversions.Conversion' 1474 produces: 1475 - application/json 1476 - text/json 1477 - application/xml 1478 - text/xml 1479 responses: 1480 '200': 1481 description: '' 1482 schema: 1483 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 1484 '401': 1485 description: Unauthorized 1486 '404': 1487 description: Not found 1488 '500': 1489 description: Internal Server Error 1490 summary: Update conversion specified by id 1491 tags: 1492 - Conversions 1493 '/conversions/{conversionId}/aggregated': 1494 get: 1495 consumes: [] 1496 deprecated: false 1497 parameters: 1498 - description: Id of the conversion 1499 format: int64 1500 in: path 1501 name: conversionId 1502 required: true 1503 type: integer 1504 - description: Timeframe of the request. See list at $timeframeList 1505 enum: 1506 - today 1507 - yesterday 1508 - last7 1509 - last30 1510 - lastmonth 1511 - currentmonth 1512 - previousmonth 1513 - last90 1514 - last120 1515 - last180 1516 - last12months 1517 - lastyear 1518 - currentyear 1519 - beginning 1520 - custom 1521 in: query 1522 name: timeFrame 1523 required: true 1524 type: string 1525 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 1526 in: query 1527 name: fromDay 1528 required: false 1529 type: string 1530 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 1531 in: query 1532 name: toDay 1533 required: false 1534 type: string 1535 - description: Filter by this tag name 1536 in: query 1537 name: tag 1538 required: false 1539 type: string 1540 - description: Is the datapoint marked as favourite 1541 in: query 1542 name: favourite 1543 required: false 1544 type: boolean 1545 - description: 'If using "yesterday" or "today" timeframe you can ask for the hourly detail' 1546 in: query 1547 name: hourly 1548 required: false 1549 type: boolean 1550 produces: 1551 - application/json 1552 - text/json 1553 responses: 1554 '200': 1555 description: '' 1556 schema: 1557 $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedResult' 1558 '401': 1559 description: Unauthorized 1560 '500': 1561 description: Internal Server Error 1562 summary: Retrieve statistics about this conversion for a timeframe 1563 tags: 1564 - Conversions 1565 '/conversions/{conversionId}/aggregated/list': 1566 get: 1567 consumes: [] 1568 deprecated: false 1569 parameters: 1570 - description: Id of the conversion 1571 format: int64 1572 in: path 1573 name: conversionId 1574 required: true 1575 type: integer 1576 - description: Timeframe of the request. See list at $timeframeList 1577 enum: 1578 - today 1579 - yesterday 1580 - last7 1581 - last30 1582 - lastmonth 1583 - currentmonth 1584 - previousmonth 1585 - last90 1586 - last120 1587 - last180 1588 - last12months 1589 - lastyear 1590 - currentyear 1591 - beginning 1592 - custom 1593 in: query 1594 name: timeFrame 1595 required: true 1596 type: string 1597 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 1598 in: query 1599 name: fromDay 1600 required: false 1601 type: string 1602 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 1603 in: query 1604 name: toDay 1605 required: false 1606 type: string 1607 - description: 'The temporal entity you want to group by ("week"/"month"). If unspecified is "day".' 1608 enum: 1609 - week 1610 - month 1611 in: query 1612 name: groupBy 1613 required: false 1614 type: string 1615 produces: 1616 - application/json 1617 - text/json 1618 responses: 1619 '200': 1620 description: '' 1621 schema: 1622 $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Aggregated.AggregatedResult]' 1623 '401': 1624 description: Unauthorized 1625 '500': 1626 description: Internal Server Error 1627 summary: Retrieve statistics about this conversion for a timeframe grouped by some temporal entity (day/week/month) 1628 tags: 1629 - Conversions 1630 '/conversions/{conversionId}/datapoints': 1631 get: 1632 consumes: [] 1633 deprecated: false 1634 parameters: 1635 - description: Id of the conversion 1636 format: int64 1637 in: path 1638 name: conversionId 1639 required: true 1640 type: integer 1641 - description: Offset where to start from 1642 format: int32 1643 in: query 1644 minLength: 0 1645 name: offset 1646 required: false 1647 type: integer 1648 - description: Limit results to this number 1649 format: int32 1650 in: query 1651 maxLength: 0 1652 minLength: 0 1653 name: limit 1654 required: false 1655 type: integer 1656 - description: 'Type of datapoint ("tl"/"tp")' 1657 enum: 1658 - tp 1659 - tl 1660 in: query 1661 name: type 1662 required: false 1663 type: string 1664 - description: 'Status of datapoint ("deleted"/"active"/"paused"/"spam")' 1665 enum: 1666 - deleted 1667 - active 1668 - paused 1669 - spam 1670 in: query 1671 name: status 1672 required: false 1673 type: string 1674 - description: Filter by this tag name 1675 in: query 1676 name: tags 1677 required: false 1678 type: string 1679 - description: Filter fields by this pattern 1680 in: query 1681 name: textSearch 1682 required: false 1683 type: string 1684 - description: Exclude datapoints created before this date (YYYYMMDD) 1685 in: query 1686 name: createdAfter 1687 required: false 1688 type: string 1689 - description: Exclude datapoints created after this date (YYYYMMDD) 1690 in: query 1691 name: createdBefore 1692 required: false 1693 type: string 1694 produces: 1695 - application/json 1696 - text/json 1697 responses: 1698 '200': 1699 description: '' 1700 schema: 1701 $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]' 1702 '401': 1703 description: Unauthorized 1704 '500': 1705 description: Internal Server Error 1706 summary: Retrieve a list of datapoints connected to this conversion 1707 tags: 1708 - Conversions 1709 '/conversions/{conversionId}/datapoints/batch/patch': 1710 put: 1711 consumes: 1712 - application/json 1713 - text/json 1714 - application/x-www-form-urlencoded 1715 deprecated: false 1716 parameters: 1717 - description: Id of the conversion 1718 format: int64 1719 in: path 1720 name: conversionId 1721 required: true 1722 type: integer 1723 - description: Patch requests 1724 in: body 1725 name: data 1726 required: true 1727 schema: 1728 $ref: '#/definitions/Api.Core.Requests.PatchBodyBatch' 1729 produces: 1730 - application/json 1731 - text/json 1732 - application/xml 1733 - text/xml 1734 responses: 1735 '200': 1736 description: '' 1737 schema: 1738 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 1739 '401': 1740 description: Unauthorized 1741 '404': 1742 description: Not found 1743 '500': 1744 description: Internal Server Error 1745 summary: Modify the association between a conversion and multiple datapoints 1746 tags: 1747 - Conversions 1748 '/conversions/{conversionId}/datapoints/count': 1749 get: 1750 consumes: [] 1751 deprecated: false 1752 parameters: 1753 - description: Id of the conversion 1754 format: int64 1755 in: path 1756 name: conversionId 1757 required: true 1758 type: integer 1759 - description: 'Type of datapoint ("tl"/"tp")' 1760 in: query 1761 name: type 1762 required: false 1763 type: string 1764 - description: 'Status of datapoint ("deleted"/"active"/"paused"/"spam")' 1765 in: query 1766 name: status 1767 required: false 1768 type: string 1769 - description: Filter by this tag name 1770 in: query 1771 name: tags 1772 required: false 1773 type: string 1774 - description: Filter fields by this pattern 1775 in: query 1776 name: textSearch 1777 required: false 1778 type: string 1779 - description: Exclude datapoints created before this date (YYYYMMDD) 1780 in: query 1781 name: createdAfter 1782 required: false 1783 type: string 1784 - description: Exclude datapoints created after this date (YYYYMMDD) 1785 in: query 1786 name: createdBefore 1787 required: false 1788 type: string 1789 produces: 1790 - application/json 1791 - text/json 1792 - application/xml 1793 - text/xml 1794 responses: 1795 '200': 1796 description: '' 1797 schema: 1798 $ref: '#/definitions/Api.Core.Responses.CountResponce' 1799 '401': 1800 description: Unauthorized 1801 '500': 1802 description: Internal Server Error 1803 summary: Retrieve a count of datapoints connected to this conversion 1804 tags: 1805 - Conversions 1806 '/conversions/{conversionId}/datapoints/patch': 1807 put: 1808 consumes: 1809 - application/json 1810 - text/json 1811 - application/xml 1812 - text/xml 1813 - application/x-www-form-urlencoded 1814 deprecated: false 1815 parameters: 1816 - description: Id of the conversion 1817 format: int64 1818 in: path 1819 name: conversionId 1820 required: true 1821 type: integer 1822 - description: Patch request 1823 in: body 1824 name: data 1825 required: true 1826 schema: 1827 $ref: '#/definitions/Api.Core.Requests.ConversionPatchBody' 1828 produces: 1829 - application/json 1830 - text/json 1831 - application/xml 1832 - text/xml 1833 responses: 1834 '200': 1835 description: '' 1836 schema: 1837 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 1838 '401': 1839 description: Unauthorized 1840 '404': 1841 description: Not found 1842 '500': 1843 description: Internal Server Error 1844 summary: Modify the association between a conversion and a datapoint 1845 tags: 1846 - Conversions 1847 '/conversions/{conversionId}/hits': 1848 get: 1849 consumes: [] 1850 deprecated: false 1851 parameters: 1852 - description: Id of the conversion 1853 format: int64 1854 in: path 1855 name: conversionId 1856 required: true 1857 type: integer 1858 - description: Timeframe of the request. See list at $timeframeList 1859 enum: 1860 - yesterday 1861 - last7 1862 - last30 1863 - lastmonth 1864 - currentmonth 1865 - previousmonth 1866 - last90 1867 - last120 1868 - last180 1869 - custom 1870 in: query 1871 name: timeframe 1872 required: true 1873 type: string 1874 - description: Limit results to this number 1875 format: int32 1876 in: query 1877 maxLength: 0 1878 minLength: 0 1879 name: limit 1880 required: false 1881 type: integer 1882 - description: "Offset where to start from (it's the lastKey field in the response object)" 1883 in: query 1884 name: offset 1885 required: false 1886 type: string 1887 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 1888 in: query 1889 name: fromDay 1890 required: false 1891 type: string 1892 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 1893 in: query 1894 name: toDay 1895 required: false 1896 type: string 1897 - description: 'Filter event type ("spiders"/"uniques"/"nonuniques"/"conversions")' 1898 enum: 1899 - spiders 1900 - uniques 1901 - nonuniques 1902 - conversions 1903 in: query 1904 name: filter 1905 required: false 1906 type: string 1907 produces: 1908 - application/json 1909 - text/json 1910 responses: 1911 '200': 1912 description: '' 1913 schema: 1914 $ref: '#/definitions/Api.Core.Dto.ClickStream.HitListPage' 1915 '401': 1916 description: Unauthorized 1917 '500': 1918 description: Internal Server Error 1919 summary: Retrieve the list of events related to this conversion. 1920 tags: 1921 - Conversions 1922 '/conversions/{conversionId}/notes': 1923 put: 1924 consumes: 1925 - application/json 1926 - text/json 1927 - application/xml 1928 - text/xml 1929 - application/x-www-form-urlencoded 1930 deprecated: false 1931 parameters: 1932 - description: Id of the conversion 1933 format: int64 1934 in: path 1935 name: conversionId 1936 required: true 1937 type: integer 1938 - description: Patch requests 1939 in: body 1940 name: note 1941 required: true 1942 schema: 1943 $ref: '#/definitions/Api.Core.Requests.GenericTextPatch' 1944 produces: 1945 - application/json 1946 - text/json 1947 - application/xml 1948 - text/xml 1949 responses: 1950 '200': 1951 description: '' 1952 schema: 1953 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 1954 '401': 1955 description: Unauthorized 1956 '403': 1957 description: Forbidden 1958 '404': 1959 description: Not found 1960 '500': 1961 description: Internal Server Error 1962 summary: 'Fast patch the "notes" field of a conversion' 1963 tags: 1964 - Conversions 1965 '/conversions/{conversionId}/reports': 1966 get: 1967 consumes: [] 1968 deprecated: false 1969 parameters: 1970 - description: Id of the conversion 1971 format: int64 1972 in: path 1973 name: conversionId 1974 required: true 1975 type: integer 1976 - description: Type of the report. 1977 enum: 1978 - datapoints 1979 - groups 1980 - browsers 1981 - browsersfamilies 1982 - platforms 1983 - cities 1984 - countries 1985 - keywords 1986 - referrers 1987 - convparameters 1988 - destinations 1989 - languages 1990 - params 1991 in: query 1992 name: type 1993 required: true 1994 type: string 1995 - description: Timeframe of the request. See list at $timeframeList 1996 enum: 1997 - yesterday 1998 - last7 1999 - last30 2000 - lastmonth 2001 - currentmonth 2002 - previousmonth 2003 - last90 2004 - last120 2005 - last180 2006 - beginning 2007 - custom 2008 in: query 2009 name: timeframe 2010 required: true 2011 type: string 2012 - description: Type of the event you want to filter this report with. By default no filter is applied. 2013 enum: 2014 - clicks 2015 - views 2016 in: query 2017 name: hittype 2018 required: false 2019 type: string 2020 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 2021 in: query 2022 name: fromDay 2023 required: false 2024 type: string 2025 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 2026 in: query 2027 name: toDay 2028 required: false 2029 type: string 2030 produces: 2031 - application/json 2032 - text/json 2033 responses: 2034 '200': 2035 description: '' 2036 schema: 2037 $ref: '#/definitions/Api.Core.Dto.Tops.Top' 2038 '401': 2039 description: Forbidden 2040 '404': 2041 description: Not found 2042 '500': 2043 description: Internal Server Error 2044 summary: Retrieve a top report connected to this conversion 2045 tags: 2046 - Conversions 2047 /datapoints: 2048 get: 2049 consumes: [] 2050 deprecated: false 2051 parameters: 2052 - default: 0 2053 description: Where to start when retrieving elements. Default is 0 if not specified. 2054 format: int32 2055 in: query 2056 minLength: 0 2057 name: offset 2058 required: false 2059 type: integer 2060 - default: 20 2061 description: Maximum elements to retrieve. Default to 20 if not specified. 2062 format: int32 2063 in: query 2064 maxLength: 0 2065 minLength: 0 2066 name: limit 2067 required: false 2068 type: integer 2069 - description: 'Type of the datapoint ("tp"/"tl")' 2070 enum: 2071 - tp 2072 - tl 2073 in: query 2074 name: type 2075 required: false 2076 type: string 2077 - description: Status of the datapoint 2078 enum: 2079 - deleted 2080 - active 2081 - paused 2082 - spam 2083 in: query 2084 name: status 2085 required: false 2086 type: string 2087 - description: A comma separated list of tags you want to filter with. 2088 in: query 2089 name: tags 2090 required: false 2091 type: string 2092 - description: Filter fields by this pattern 2093 in: query 2094 name: textSearch 2095 required: false 2096 type: string 2097 - description: Filter fields by favourite status 2098 in: query 2099 name: onlyFavorites 2100 required: false 2101 type: boolean 2102 - description: Field to sort by 2103 in: query 2104 name: sortBy 2105 required: false 2106 type: string 2107 - description: 'Direction of sort "asc" or "desc"' 2108 enum: 2109 - asc 2110 - desc 2111 in: query 2112 name: sortDirection 2113 required: false 2114 type: string 2115 - description: Exclude datapoints created before this date (YYYYMMDD) 2116 in: query 2117 name: createdAfter 2118 required: false 2119 type: string 2120 - description: Exclude datapoints created after this date (YYYYMMDD) 2121 in: query 2122 name: createdBefore 2123 required: false 2124 type: string 2125 produces: 2126 - application/json 2127 - text/json 2128 responses: 2129 '200': 2130 description: '' 2131 schema: 2132 $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]' 2133 '401': 2134 description: Unauthorized 2135 '404': 2136 description: Not found 2137 '500': 2138 description: Internal Server Error 2139 summary: List of all the datapoints associated to the user 2140 tags: 2141 - DataPoints 2142 post: 2143 consumes: 2144 - application/json 2145 - text/json 2146 - application/x-www-form-urlencoded 2147 deprecated: false 2148 parameters: 2149 - description: The body of the datapoint 2150 in: body 2151 name: value 2152 required: true 2153 schema: 2154 $ref: '#/definitions/Api.Core.Dto.Datapoints.Datapoint' 2155 produces: 2156 - application/json 2157 - text/json 2158 - application/xml 2159 - text/xml 2160 responses: 2161 '200': 2162 description: '' 2163 schema: 2164 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 2165 '401': 2166 description: Unauthorized 2167 '404': 2168 description: Not found 2169 '500': 2170 description: Internal Server Error 2171 summary: Create a datapoint 2172 tags: 2173 - DataPoints 2174 /datapoints/aggregated: 2175 get: 2176 consumes: [] 2177 deprecated: false 2178 parameters: 2179 - description: Timeframe of the request. See list at $timeframeList 2180 enum: 2181 - today 2182 - yesterday 2183 - last7 2184 - last30 2185 - lastmonth 2186 - currentmonth 2187 - previousmonth 2188 - last90 2189 - last120 2190 - last180 2191 - last12months 2192 - lastyear 2193 - currentyear 2194 - beginning 2195 - custom 2196 in: query 2197 name: timeFrame 2198 required: true 2199 type: string 2200 - description: 'Type of datapoint ("tl"/"tp")' 2201 enum: 2202 - tp 2203 - tl 2204 in: query 2205 name: type 2206 required: false 2207 type: string 2208 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 2209 in: query 2210 name: fromDay 2211 required: false 2212 type: string 2213 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 2214 in: query 2215 name: toDay 2216 required: false 2217 type: string 2218 - description: 'If using "yesterday" or "today" timeframe you can ask for the hourly detail' 2219 in: query 2220 name: hourly 2221 required: false 2222 type: boolean 2223 - description: 'Status of datapoint ("deleted"/"active"/"paused"/"spam")' 2224 enum: 2225 - deleted 2226 - active 2227 - paused 2228 - spam 2229 in: query 2230 name: status 2231 required: false 2232 type: string 2233 - description: A comma separated list of tags you want to filter with. 2234 in: query 2235 name: tag 2236 required: false 2237 type: string 2238 - description: Is the datapoint is marked as favourite 2239 in: query 2240 name: favourite 2241 required: false 2242 type: boolean 2243 produces: 2244 - application/json 2245 - text/json 2246 responses: 2247 '200': 2248 description: '' 2249 schema: 2250 $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedResult' 2251 '401': 2252 description: Unauthorized 2253 '500': 2254 description: Internal Server Error 2255 summary: Retrieve statistics about this customer for a timeframe by groups 2256 tags: 2257 - DataPoints 2258 /datapoints/aggregated/list: 2259 get: 2260 consumes: [] 2261 deprecated: false 2262 parameters: 2263 - description: 'Type of datapoint ("tl"/"tp")' 2264 enum: 2265 - tp 2266 - tl 2267 in: query 2268 name: type 2269 required: true 2270 type: string 2271 - description: Timeframe of the request. See list at $timeframeList 2272 enum: 2273 - today 2274 - yesterday 2275 - last7 2276 - last30 2277 - lastmonth 2278 - currentmonth 2279 - previousmonth 2280 - last90 2281 - last120 2282 - last180 2283 - last12months 2284 - lastyear 2285 - currentyear 2286 - beginning 2287 - custom 2288 in: query 2289 name: timeFrame 2290 required: true 2291 type: string 2292 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 2293 in: query 2294 name: fromDay 2295 required: false 2296 type: string 2297 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 2298 in: query 2299 name: toDay 2300 required: false 2301 type: string 2302 - description: 'Status of datapoint ("deleted"/"active"/"paused"/"spam")' 2303 enum: 2304 - deleted 2305 - active 2306 - paused 2307 - spam 2308 in: query 2309 name: status 2310 required: false 2311 type: string 2312 - description: A comma separated list of tags you want to filter with. 2313 in: query 2314 name: tag 2315 required: false 2316 type: string 2317 - description: Is the datapoint is marked as favourite 2318 in: query 2319 name: favourite 2320 required: false 2321 type: boolean 2322 - description: 'The temporal entity you want to group by ("week"/"month"). If unspecified is "day".' 2323 enum: 2324 - week 2325 - month 2326 in: query 2327 name: groupBy 2328 required: false 2329 type: string 2330 produces: 2331 - application/json 2332 - text/json 2333 responses: 2334 '200': 2335 description: '' 2336 schema: 2337 $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Aggregated.AggregatedResult]' 2338 '401': 2339 description: Unauthorized 2340 '500': 2341 description: Internal Server Error 2342 summary: Retrieve statistics about all datapoints of this customer for a timeframe grouped by some temporal entity (day/week/month) 2343 tags: 2344 - DataPoints 2345 /datapoints/batch: 2346 delete: 2347 consumes: 2348 - application/json 2349 - text/json 2350 - application/x-www-form-urlencoded 2351 deprecated: false 2352 parameters: 2353 - description: A json containing the datapoints to delete. 2354 in: body 2355 name: batch 2356 required: true 2357 schema: 2358 $ref: '#/definitions/Api.Core.Requests.DeleteBatch' 2359 produces: 2360 - application/json 2361 - text/json 2362 responses: 2363 '200': 2364 description: '' 2365 schema: 2366 $ref: '#/definitions/Api.Core.Responses.ModifyBatchItemResponce[Api.Core.Dto.Datapoints.Datapoint,System.Int64]' 2367 '401': 2368 description: Unauthorized 2369 '404': 2370 description: Not found 2371 '500': 2372 description: Internal Server Error 2373 summary: Delete multiple datapoints 2374 tags: 2375 - DataPoints 2376 post: 2377 consumes: 2378 - application/json 2379 - text/json 2380 - application/x-www-form-urlencoded 2381 deprecated: false 2382 parameters: 2383 - description: A json containing the datapoints to update. 2384 in: body 2385 name: batch 2386 required: true 2387 schema: 2388 $ref: '#/definitions/Api.Core.Requests.DatapointsBatch' 2389 produces: 2390 - application/json 2391 - text/json 2392 responses: 2393 '200': 2394 description: '' 2395 schema: 2396 $ref: '#/definitions/Api.Core.Responses.ModifyBatchItemResponce[Api.Core.Dto.Datapoints.Datapoint,System.Int64]' 2397 '401': 2398 description: Unauthorized 2399 '404': 2400 description: Not found 2401 '500': 2402 description: Internal Server Error 2403 summary: Update multiple datapoints 2404 tags: 2405 - DataPoints 2406 put: 2407 consumes: 2408 - application/json 2409 - text/json 2410 - application/x-www-form-urlencoded 2411 deprecated: false 2412 parameters: 2413 - description: A json containing the datapoints to create. 2414 in: body 2415 name: batch 2416 required: true 2417 schema: 2418 $ref: '#/definitions/Api.Core.Requests.DatapointsBatch' 2419 produces: 2420 - application/json 2421 - text/json 2422 responses: 2423 '200': 2424 description: '' 2425 schema: 2426 $ref: '#/definitions/Api.Core.Responses.ModifyBatchItemResponce[Api.Core.Dto.Datapoints.Datapoint,System.Int64]' 2427 '401': 2428 description: Unauthorized 2429 '404': 2430 description: Not found 2431 '500': 2432 description: Internal Server Error 2433 summary: Create multiple datapoints 2434 tags: 2435 - DataPoints 2436 /datapoints/count: 2437 get: 2438 consumes: [] 2439 deprecated: false 2440 parameters: 2441 - description: 'Type of the datapoint ("tp"/"tl")' 2442 enum: 2443 - tp 2444 - tl 2445 in: query 2446 name: type 2447 required: false 2448 type: string 2449 - description: Status of the datapoint 2450 enum: 2451 - deleted 2452 - active 2453 - paused 2454 - spam 2455 in: query 2456 name: status 2457 required: false 2458 type: string 2459 - description: A comma separated list of tags you want to filter with. 2460 in: query 2461 name: tags 2462 required: false 2463 type: string 2464 - description: Filter fields by this pattern 2465 in: query 2466 name: textSearch 2467 required: false 2468 type: string 2469 - description: Filter fields by favourite status 2470 in: query 2471 name: onlyFavorites 2472 required: false 2473 type: boolean 2474 - description: Exclude datapoints created before this date (YYYYMMDD) 2475 in: query 2476 name: createdAfter 2477 required: false 2478 type: string 2479 - description: Exclude datapoints created after this date (YYYYMMDD) 2480 in: query 2481 name: createdBefore 2482 required: false 2483 type: string 2484 produces: 2485 - application/json 2486 - text/json 2487 - application/xml 2488 - text/xml 2489 responses: 2490 '200': 2491 description: '' 2492 schema: 2493 $ref: '#/definitions/Api.Core.Responses.CountResponce' 2494 '401': 2495 description: Unauthorized 2496 '404': 2497 description: Not found 2498 '500': 2499 description: Internal Server Error 2500 summary: Count the datapoints associated to the user 2501 tags: 2502 - DataPoints 2503 '/datapoints/{id}': 2504 delete: 2505 consumes: [] 2506 deprecated: false 2507 parameters: 2508 - description: The id of the datapoint 2509 format: int64 2510 in: path 2511 name: id 2512 required: true 2513 type: integer 2514 produces: 2515 - application/json 2516 - text/json 2517 - application/xml 2518 - text/xml 2519 responses: 2520 '200': 2521 description: '' 2522 schema: 2523 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 2524 '401': 2525 description: Unauthorized 2526 '404': 2527 description: Not found 2528 '500': 2529 description: Internal Server Error 2530 summary: Delete a datapoint 2531 tags: 2532 - DataPoints 2533 get: 2534 consumes: [] 2535 deprecated: false 2536 parameters: 2537 - description: The id of the datapoint 2538 format: int64 2539 in: path 2540 name: id 2541 required: true 2542 type: integer 2543 produces: 2544 - application/json 2545 - text/json 2546 responses: 2547 '200': 2548 description: '' 2549 schema: 2550 $ref: '#/definitions/Api.Core.Dto.Datapoints.Datapoint' 2551 '401': 2552 description: Unauthorized 2553 '404': 2554 description: Not found 2555 '500': 2556 description: Internal Server Error 2557 summary: Get a datapoint 2558 tags: 2559 - DataPoints 2560 post: 2561 consumes: 2562 - application/json 2563 - text/json 2564 - application/x-www-form-urlencoded 2565 deprecated: false 2566 parameters: 2567 - description: The id of the datapoint 2568 format: int64 2569 in: path 2570 name: id 2571 required: true 2572 type: integer 2573 - description: The body of the datapoint 2574 in: body 2575 name: value 2576 required: true 2577 schema: 2578 $ref: '#/definitions/Api.Core.Dto.Datapoints.Datapoint' 2579 produces: 2580 - application/json 2581 - text/json 2582 - application/xml 2583 - text/xml 2584 responses: 2585 '200': 2586 description: '' 2587 schema: 2588 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 2589 '401': 2590 description: Unauthorized 2591 '404': 2592 description: Not found 2593 '500': 2594 description: Internal Server Error 2595 summary: Update a datapoint 2596 tags: 2597 - DataPoints 2598 '/datapoints/{id}/aggregated': 2599 get: 2600 consumes: [] 2601 deprecated: false 2602 parameters: 2603 - description: Id of the datapoint 2604 format: int64 2605 in: path 2606 name: id 2607 required: true 2608 type: integer 2609 - description: Timeframe of the request. See list at $timeframeList 2610 enum: 2611 - today 2612 - yesterday 2613 - last7 2614 - last30 2615 - lastmonth 2616 - currentmonth 2617 - previousmonth 2618 - last90 2619 - last120 2620 - last180 2621 - last12months 2622 - lastyear 2623 - currentyear 2624 - beginning 2625 - custom 2626 in: query 2627 name: timeFrame 2628 required: true 2629 type: string 2630 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 2631 in: query 2632 name: fromDay 2633 required: false 2634 type: string 2635 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 2636 in: query 2637 name: toDay 2638 required: false 2639 type: string 2640 - description: 'If using "yesterday" or "today" timeframe you can ask for the hourly detail' 2641 in: query 2642 name: hourly 2643 required: false 2644 type: boolean 2645 produces: 2646 - application/json 2647 - text/json 2648 responses: 2649 '200': 2650 description: '' 2651 schema: 2652 $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedResult' 2653 '401': 2654 description: Unauthorized 2655 '500': 2656 description: Internal Server Error 2657 summary: Retrieve statistics about this datapoint for a timeframe 2658 tags: 2659 - DataPoints 2660 '/datapoints/{id}/aggregated/list': 2661 get: 2662 consumes: [] 2663 deprecated: false 2664 parameters: 2665 - description: Id of the datapoint 2666 format: int64 2667 in: path 2668 name: id 2669 required: true 2670 type: integer 2671 - description: Timeframe of the request. See list at $timeframeList 2672 enum: 2673 - today 2674 - yesterday 2675 - last7 2676 - last30 2677 - lastmonth 2678 - currentmonth 2679 - previousmonth 2680 - last90 2681 - last120 2682 - last180 2683 - last12months 2684 - lastyear 2685 - currentyear 2686 - beginning 2687 - custom 2688 in: query 2689 name: timeFrame 2690 required: true 2691 type: string 2692 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 2693 in: query 2694 name: fromDay 2695 required: false 2696 type: string 2697 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 2698 in: query 2699 name: toDay 2700 required: false 2701 type: string 2702 - description: 'The temporal entity you want to group by ("week"/"month"). If unspecified is "day".' 2703 enum: 2704 - week 2705 - month 2706 in: query 2707 name: groupBy 2708 required: false 2709 type: string 2710 produces: 2711 - application/json 2712 - text/json 2713 responses: 2714 '200': 2715 description: '' 2716 schema: 2717 $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Aggregated.AggregatedResult]' 2718 '401': 2719 description: Unauthorized 2720 '500': 2721 description: Internal Server Error 2722 summary: Retrieve statistics about this datapoint for a timeframe grouped by some temporal entity (day/week/month) 2723 tags: 2724 - DataPoints 2725 '/datapoints/{id}/favourite': 2726 put: 2727 consumes: [] 2728 deprecated: false 2729 parameters: 2730 - description: Id of the datapoint 2731 format: int64 2732 in: path 2733 name: id 2734 required: true 2735 type: integer 2736 produces: 2737 - application/json 2738 - text/json 2739 - application/xml 2740 - text/xml 2741 responses: 2742 '200': 2743 description: '' 2744 schema: 2745 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 2746 '401': 2747 description: Unauthorized 2748 '403': 2749 description: Forbidden 2750 '404': 2751 description: Not found 2752 '500': 2753 description: Internal Server Error 2754 summary: 'Fast switch the "favourite" field of a datapoint' 2755 tags: 2756 - DataPoints 2757 '/datapoints/{id}/hits': 2758 get: 2759 consumes: [] 2760 deprecated: false 2761 parameters: 2762 - description: Id of the datapoint 2763 format: int64 2764 in: path 2765 name: id 2766 required: true 2767 type: integer 2768 - description: Timeframe of the request. See list at $timeframeList 2769 enum: 2770 - yesterday 2771 - last7 2772 - last30 2773 - lastmonth 2774 - currentmonth 2775 - previousmonth 2776 - last90 2777 - last120 2778 - last180 2779 - custom 2780 in: query 2781 name: timeframe 2782 required: true 2783 type: string 2784 - description: Limit results to this number 2785 format: int32 2786 in: query 2787 maxLength: 0 2788 minLength: 0 2789 name: limit 2790 required: false 2791 type: integer 2792 - description: "Offset where to start from (it's the lastKey field in the response object)" 2793 in: query 2794 name: offset 2795 required: false 2796 type: string 2797 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 2798 in: query 2799 name: fromDay 2800 required: false 2801 type: string 2802 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 2803 in: query 2804 name: toDay 2805 required: false 2806 type: string 2807 - description: 'Filter event type ("spiders"/"uniques"/"nonuniques"/"conversions")' 2808 enum: 2809 - spiders 2810 - uniques 2811 - nonuniques 2812 - conversions 2813 in: query 2814 name: filter 2815 required: false 2816 type: string 2817 produces: 2818 - application/json 2819 - text/json 2820 responses: 2821 '200': 2822 description: '' 2823 schema: 2824 $ref: '#/definitions/Api.Core.Dto.ClickStream.HitListPage' 2825 '401': 2826 description: Unauthorized 2827 '500': 2828 description: Internal Server Error 2829 summary: Retrieve the list of events related to this datapoint. 2830 tags: 2831 - DataPoints 2832 '/datapoints/{id}/notes': 2833 put: 2834 consumes: 2835 - application/json 2836 - text/json 2837 - application/xml 2838 - text/xml 2839 - application/x-www-form-urlencoded 2840 deprecated: false 2841 parameters: 2842 - description: Id of the datapoint 2843 format: int64 2844 in: path 2845 name: id 2846 required: true 2847 type: integer 2848 - description: Patch requests 2849 in: body 2850 name: note 2851 required: true 2852 schema: 2853 $ref: '#/definitions/Api.Core.Requests.GenericTextPatch' 2854 produces: 2855 - application/json 2856 - text/json 2857 - application/xml 2858 - text/xml 2859 responses: 2860 '200': 2861 description: '' 2862 schema: 2863 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 2864 '401': 2865 description: Unauthorized 2866 '403': 2867 description: Forbidden 2868 '404': 2869 description: Not found 2870 '500': 2871 description: Internal Server Error 2872 summary: 'Fast patch the "notes" field of a datapoint' 2873 tags: 2874 - DataPoints 2875 '/datapoints/{id}/reports': 2876 get: 2877 consumes: [] 2878 deprecated: false 2879 parameters: 2880 - description: Id of the datapoint 2881 format: int64 2882 in: path 2883 name: id 2884 required: true 2885 type: integer 2886 - description: Type of the report. 2887 enum: 2888 - browsers 2889 - browsersfamilies 2890 - platforms 2891 - cities 2892 - countries 2893 - isps 2894 - ips 2895 - oss 2896 - ossfamilies 2897 - keywords 2898 - referrers 2899 - destinations 2900 - languages 2901 - params 2902 in: query 2903 name: type 2904 required: true 2905 type: string 2906 - description: Timeframe of the request. See list at $timeframeList 2907 enum: 2908 - yesterday 2909 - last7 2910 - last30 2911 - lastmonth 2912 - currentmonth 2913 - previousmonth 2914 - last90 2915 - last120 2916 - last180 2917 - beginning 2918 - custom 2919 in: query 2920 name: timeframe 2921 required: true 2922 type: string 2923 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 2924 in: query 2925 name: fromDay 2926 required: false 2927 type: string 2928 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 2929 in: query 2930 name: toDay 2931 required: false 2932 type: string 2933 produces: 2934 - application/json 2935 - text/json 2936 responses: 2937 '200': 2938 description: '' 2939 schema: 2940 $ref: '#/definitions/Api.Core.Dto.Tops.Top' 2941 '401': 2942 description: Forbidden 2943 '404': 2944 description: Not found 2945 '500': 2946 description: Internal Server Error 2947 summary: Retrieve a top report connected to this datapoint 2948 tags: 2949 - DataPoints 2950 /domains: 2951 get: 2952 consumes: [] 2953 deprecated: false 2954 parameters: 2955 - description: Offset where to start from 2956 format: int32 2957 in: query 2958 minLength: 0 2959 name: offset 2960 required: false 2961 type: integer 2962 - description: Limit results to this number 2963 format: int32 2964 in: query 2965 maxLength: 0 2966 minLength: 0 2967 name: limit 2968 required: false 2969 type: integer 2970 - default: system 2971 description: 'Type of domain ("system"/"go"/"personal"/"dedicated"). If not specified default is "system"' 2972 enum: 2973 - system 2974 - go 2975 - personal 2976 - dedicated 2977 in: query 2978 name: type 2979 required: false 2980 type: string 2981 - description: Filter domains with this anmen 2982 in: query 2983 name: name 2984 required: false 2985 type: string 2986 produces: 2987 - application/json 2988 - text/json 2989 responses: 2990 '200': 2991 description: '' 2992 schema: 2993 $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]' 2994 '401': 2995 description: Unauthorized 2996 '500': 2997 description: Internal Server Error 2998 summary: Retrieve a list of domains 2999 tags: 3000 - Domains 3001 post: 3002 consumes: 3003 - application/json 3004 - text/json 3005 - application/xml 3006 - text/xml 3007 - application/x-www-form-urlencoded 3008 deprecated: false 3009 parameters: 3010 - description: The domain to create 3011 in: body 3012 name: value 3013 required: true 3014 schema: 3015 $ref: '#/definitions/Api.Core.Dto.Domains.Domain' 3016 produces: 3017 - application/json 3018 - text/json 3019 - application/xml 3020 - text/xml 3021 responses: 3022 '200': 3023 description: '' 3024 schema: 3025 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 3026 '401': 3027 description: Unauthorized 3028 '500': 3029 description: Internal Server Error 3030 summary: Create a domain 3031 tags: 3032 - Domains 3033 /domains/count: 3034 get: 3035 consumes: [] 3036 deprecated: false 3037 parameters: 3038 - default: system 3039 description: 'Type of domain ("system"/"go"/"personal"/"dedicated"). If not specified default is "system"' 3040 enum: 3041 - system 3042 - go 3043 - personal 3044 - dedicated 3045 in: query 3046 name: type 3047 required: false 3048 type: string 3049 - description: Filter domains with this anmen 3050 in: query 3051 name: name 3052 required: false 3053 type: string 3054 produces: 3055 - application/json 3056 - text/json 3057 - application/xml 3058 - text/xml 3059 responses: 3060 '200': 3061 description: '' 3062 schema: 3063 $ref: '#/definitions/Api.Core.Responses.CountResponce' 3064 '401': 3065 description: Unauthorized 3066 '500': 3067 description: Internal Server Error 3068 summary: Retrieve count of domains 3069 tags: 3070 - Domains 3071 '/domains/{id}': 3072 delete: 3073 consumes: [] 3074 deprecated: false 3075 parameters: 3076 - description: Id of domain 3077 format: int64 3078 in: path 3079 name: id 3080 required: true 3081 type: integer 3082 produces: 3083 - application/json 3084 - text/json 3085 - application/xml 3086 - text/xml 3087 responses: 3088 '200': 3089 description: '' 3090 schema: 3091 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 3092 '401': 3093 description: Unauthorized 3094 '500': 3095 description: Internal Server Error 3096 summary: Delete a domain 3097 tags: 3098 - Domains 3099 get: 3100 consumes: [] 3101 deprecated: false 3102 parameters: 3103 - description: Id of domain 3104 format: int64 3105 in: path 3106 name: id 3107 required: true 3108 type: integer 3109 produces: 3110 - application/json 3111 - text/json 3112 - application/xml 3113 - text/xml 3114 responses: 3115 '200': 3116 description: '' 3117 schema: 3118 $ref: '#/definitions/Api.Core.Dto.Domains.Domain' 3119 '401': 3120 description: Unauthorized 3121 '500': 3122 description: Internal Server Error 3123 summary: Get a domain 3124 tags: 3125 - Domains 3126 post: 3127 consumes: 3128 - application/json 3129 - text/json 3130 - application/xml 3131 - text/xml 3132 - application/x-www-form-urlencoded 3133 deprecated: false 3134 parameters: 3135 - description: Id of domain 3136 format: int64 3137 in: path 3138 name: id 3139 required: true 3140 type: integer 3141 - description: The domain to update 3142 in: body 3143 name: value 3144 required: true 3145 schema: 3146 $ref: '#/definitions/Api.Core.Dto.Domains.Domain' 3147 produces: 3148 - application/json 3149 - text/json 3150 - application/xml 3151 - text/xml 3152 responses: 3153 '200': 3154 description: '' 3155 schema: 3156 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 3157 '401': 3158 description: Unauthorized 3159 '500': 3160 description: Internal Server Error 3161 summary: Update a domain 3162 tags: 3163 - Domains 3164 /groups: 3165 get: 3166 consumes: [] 3167 deprecated: false 3168 parameters: 3169 - default: 0 3170 description: Where to start when retrieving elements. Default is 0 if not specified. 3171 format: int32 3172 in: query 3173 minLength: 0 3174 name: offset 3175 required: false 3176 type: integer 3177 - default: 20 3178 description: Maximum elements to retrieve. Default to 20 if not specified. 3179 format: int32 3180 in: query 3181 maxLength: 0 3182 minLength: 0 3183 name: limit 3184 required: false 3185 type: integer 3186 - description: Status of the group 3187 enum: 3188 - deleted 3189 - active 3190 in: query 3191 name: status 3192 required: false 3193 type: string 3194 - description: A comma separated list of tags you want to filter with. 3195 in: query 3196 name: tags 3197 required: false 3198 type: string 3199 - description: Filter fields by this pattern 3200 in: query 3201 name: textSearch 3202 required: false 3203 type: string 3204 - description: Exclude groups created before this date (YYYYMMDD) 3205 in: query 3206 name: createdAfter 3207 required: false 3208 type: string 3209 - description: Exclude groups created after this date (YYYYMMDD) 3210 in: query 3211 name: createdBefore 3212 required: false 3213 type: string 3214 - description: Write permission 3215 in: query 3216 name: write 3217 required: false 3218 type: boolean 3219 produces: 3220 - application/json 3221 - text/json 3222 responses: 3223 '200': 3224 description: '' 3225 schema: 3226 $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]' 3227 '401': 3228 description: Unauthorized 3229 '404': 3230 description: Not found 3231 '500': 3232 description: Internal Server Error 3233 summary: List of all the groups associated to the user. 3234 tags: 3235 - Groups 3236 post: 3237 consumes: 3238 - application/json 3239 - text/json 3240 - application/x-www-form-urlencoded 3241 deprecated: false 3242 parameters: 3243 - description: The body of the group 3244 in: body 3245 name: value 3246 required: true 3247 schema: 3248 $ref: '#/definitions/Api.Core.Dto.Groups.Group' 3249 produces: 3250 - application/json 3251 - text/json 3252 - application/xml 3253 - text/xml 3254 responses: 3255 '200': 3256 description: '' 3257 schema: 3258 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 3259 '401': 3260 description: Unauthorized 3261 '404': 3262 description: Not found 3263 '500': 3264 description: Internal Server Error 3265 summary: Create a group 3266 tags: 3267 - Groups 3268 /groups/aggregated: 3269 get: 3270 consumes: [] 3271 deprecated: false 3272 parameters: 3273 - description: Timeframe of the request. See list at $timeframeList 3274 enum: 3275 - today 3276 - yesterday 3277 - last7 3278 - last30 3279 - lastmonth 3280 - currentmonth 3281 - previousmonth 3282 - last90 3283 - last120 3284 - last180 3285 - last12months 3286 - lastyear 3287 - currentyear 3288 - beginning 3289 - custom 3290 in: query 3291 name: timeFrame 3292 required: true 3293 type: string 3294 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 3295 in: query 3296 name: fromDay 3297 required: false 3298 type: string 3299 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 3300 in: query 3301 name: toDay 3302 required: false 3303 type: string 3304 - description: 'If using "yesterday" or "today" timeframe you can ask for the hourly detail' 3305 in: query 3306 name: hourly 3307 required: false 3308 type: boolean 3309 - description: 'Status of group ("deleted"/"active")' 3310 enum: 3311 - deleted 3312 - active 3313 in: query 3314 name: status 3315 required: false 3316 type: string 3317 - description: A comma separated list of tags you want to filter with. 3318 in: query 3319 name: tag 3320 required: false 3321 type: string 3322 - description: Is the group is marked as favourite 3323 in: query 3324 name: favourite 3325 required: false 3326 type: boolean 3327 produces: 3328 - application/json 3329 - text/json 3330 responses: 3331 '200': 3332 description: '' 3333 schema: 3334 $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedResult' 3335 '401': 3336 description: Unauthorized 3337 '500': 3338 description: Internal Server Error 3339 summary: Retrieve statistics about this customer for a timeframe by groups 3340 tags: 3341 - Groups 3342 /groups/aggregated/list: 3343 get: 3344 consumes: [] 3345 deprecated: false 3346 parameters: 3347 - description: Timeframe of the request. See list at $timeframeList 3348 enum: 3349 - today 3350 - yesterday 3351 - last7 3352 - last30 3353 - lastmonth 3354 - currentmonth 3355 - previousmonth 3356 - last90 3357 - last120 3358 - last180 3359 - last12months 3360 - lastyear 3361 - currentyear 3362 - beginning 3363 - custom 3364 in: query 3365 name: timeFrame 3366 required: true 3367 type: string 3368 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 3369 in: query 3370 name: fromDay 3371 required: false 3372 type: string 3373 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 3374 in: query 3375 name: toDay 3376 required: false 3377 type: string 3378 - description: 'Status of group ("deleted"/"active")' 3379 in: query 3380 name: status 3381 required: false 3382 type: string 3383 - description: A comma separated list of tags you want to filter with. 3384 in: query 3385 name: tag 3386 required: false 3387 type: string 3388 - description: Is the group is marked as favourite 3389 in: query 3390 name: favourite 3391 required: false 3392 type: boolean 3393 - description: 'The temporal entity you want to group by ("week"/"month"). If unspecified is "day".' 3394 enum: 3395 - deleted 3396 - active 3397 in: query 3398 name: groupBy 3399 required: false 3400 type: string 3401 produces: 3402 - application/json 3403 - text/json 3404 responses: 3405 '200': 3406 description: '' 3407 schema: 3408 $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Aggregated.AggregatedResult]' 3409 '401': 3410 description: Unauthorized 3411 '500': 3412 description: Internal Server Error 3413 summary: Retrieve statistics about all groups of this customer for a timeframe grouped by some temporal entity (day/week/month) 3414 tags: 3415 - Groups 3416 /groups/count: 3417 get: 3418 consumes: [] 3419 deprecated: false 3420 parameters: 3421 - description: Status of the datapoint 3422 enum: 3423 - deleted 3424 - active 3425 in: query 3426 name: status 3427 required: false 3428 type: string 3429 - description: A comma separated list of tags you want to filter with. 3430 in: query 3431 name: tags 3432 required: false 3433 type: string 3434 - description: Filter fields by this pattern 3435 in: query 3436 name: textSearch 3437 required: false 3438 type: string 3439 - description: Exclude groups created before this date (YYYYMMDD) 3440 in: query 3441 name: createdAfter 3442 required: false 3443 type: string 3444 - description: Exclude groups created after this date (YYYYMMDD) 3445 in: query 3446 name: createdBefore 3447 required: false 3448 type: string 3449 - description: Write permission 3450 in: query 3451 name: write 3452 required: false 3453 type: boolean 3454 produces: 3455 - application/json 3456 - text/json 3457 - application/xml 3458 - text/xml 3459 responses: 3460 '200': 3461 description: '' 3462 schema: 3463 $ref: '#/definitions/Api.Core.Responses.CountResponce' 3464 '401': 3465 description: Unauthorized 3466 '404': 3467 description: Not found 3468 '500': 3469 description: Internal Server Error 3470 summary: Count the groups associated to the user. 3471 tags: 3472 - Groups 3473 '/groups/{id}': 3474 delete: 3475 consumes: [] 3476 deprecated: false 3477 parameters: 3478 - description: Id of the group 3479 format: int64 3480 in: path 3481 name: id 3482 required: true 3483 type: integer 3484 produces: 3485 - application/json 3486 - text/json 3487 - application/xml 3488 - text/xml 3489 responses: 3490 '200': 3491 description: '' 3492 schema: 3493 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 3494 '401': 3495 description: Unauthorized 3496 '404': 3497 description: Not found 3498 '500': 3499 description: Internal Server Error 3500 summary: Delete group specified by id 3501 tags: 3502 - Groups 3503 get: 3504 consumes: [] 3505 deprecated: false 3506 parameters: 3507 - description: The id of the group 3508 format: int64 3509 in: path 3510 name: id 3511 required: true 3512 type: integer 3513 produces: 3514 - application/json 3515 - text/json 3516 responses: 3517 '200': 3518 description: '' 3519 schema: 3520 $ref: '#/definitions/Api.Core.Dto.Groups.Group' 3521 '401': 3522 description: Unauthorized 3523 '404': 3524 description: Not found 3525 '500': 3526 description: Internal Server Error 3527 summary: Get a group 3528 tags: 3529 - Groups 3530 post: 3531 consumes: 3532 - application/json 3533 - text/json 3534 - application/x-www-form-urlencoded 3535 deprecated: false 3536 parameters: 3537 - description: The id of the group 3538 format: int64 3539 in: path 3540 name: id 3541 required: true 3542 type: integer 3543 - description: The body of the group 3544 in: body 3545 name: value 3546 required: true 3547 schema: 3548 $ref: '#/definitions/Api.Core.Dto.Groups.Group' 3549 produces: 3550 - application/json 3551 - text/json 3552 - application/xml 3553 - text/xml 3554 responses: 3555 '200': 3556 description: '' 3557 schema: 3558 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 3559 '401': 3560 description: Unauthorized 3561 '404': 3562 description: Not found 3563 '500': 3564 description: Internal Server Error 3565 summary: Update a group 3566 tags: 3567 - Groups 3568 '/groups/{id}/aggregated': 3569 get: 3570 consumes: [] 3571 deprecated: false 3572 parameters: 3573 - description: Id of the group 3574 format: int64 3575 in: path 3576 name: id 3577 required: true 3578 type: integer 3579 - description: Timeframe of the request. See list at $timeframeList 3580 enum: 3581 - today 3582 - yesterday 3583 - last7 3584 - last30 3585 - lastmonth 3586 - currentmonth 3587 - previousmonth 3588 - last90 3589 - last120 3590 - last180 3591 - last12months 3592 - lastyear 3593 - currentyear 3594 - beginning 3595 - custom 3596 in: query 3597 name: timeFrame 3598 required: true 3599 type: string 3600 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 3601 in: query 3602 name: fromDay 3603 required: false 3604 type: string 3605 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 3606 in: query 3607 name: toDay 3608 required: false 3609 type: string 3610 - description: 'If using "yesterday" or "today" timeframe you can ask for the hourly detail' 3611 in: query 3612 name: hourly 3613 required: false 3614 type: boolean 3615 produces: 3616 - application/json 3617 - text/json 3618 responses: 3619 '200': 3620 description: '' 3621 schema: 3622 $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedResult' 3623 '401': 3624 description: Unauthorized 3625 '500': 3626 description: Internal Server Error 3627 summary: Retrieve statistics about this group for a timeframe 3628 tags: 3629 - Groups 3630 '/groups/{id}/aggregated/list': 3631 get: 3632 consumes: [] 3633 deprecated: false 3634 parameters: 3635 - description: Id of the group 3636 format: int64 3637 in: path 3638 name: id 3639 required: true 3640 type: integer 3641 - description: Timeframe of the request. See list at $timeframeList 3642 enum: 3643 - today 3644 - yesterday 3645 - last7 3646 - last30 3647 - lastmonth 3648 - currentmonth 3649 - previousmonth 3650 - last90 3651 - last120 3652 - last180 3653 - last12months 3654 - lastyear 3655 - currentyear 3656 - beginning 3657 - custom 3658 in: query 3659 name: timeFrame 3660 required: true 3661 type: string 3662 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 3663 in: query 3664 name: fromDay 3665 required: false 3666 type: string 3667 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 3668 in: query 3669 name: toDay 3670 required: false 3671 type: string 3672 - description: 'The temporal entity you want to group by ("week"/"month"). If unspecified is "day".' 3673 enum: 3674 - week 3675 - month 3676 in: query 3677 name: groupBy 3678 required: false 3679 type: string 3680 produces: 3681 - application/json 3682 - text/json 3683 responses: 3684 '200': 3685 description: '' 3686 schema: 3687 $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Aggregated.AggregatedResult]' 3688 '401': 3689 description: Unauthorized 3690 '500': 3691 description: Internal Server Error 3692 summary: Retrieve statistics about this group for a timeframe grouped by some temporal entity (day/week/month) 3693 tags: 3694 - Groups 3695 '/groups/{id}/aggregated/summary': 3696 get: 3697 consumes: [] 3698 deprecated: false 3699 parameters: 3700 - description: Filter by this group id 3701 format: int64 3702 in: path 3703 name: id 3704 required: true 3705 type: integer 3706 - description: Timeframe of the request. See list at $timeframeList 3707 enum: 3708 - today 3709 - yesterday 3710 - last7 3711 - last30 3712 - lastmonth 3713 - currentmonth 3714 - previousmonth 3715 - last90 3716 - last120 3717 - last180 3718 - last12months 3719 - lastyear 3720 - currentyear 3721 - beginning 3722 - custom 3723 in: query 3724 name: timeFrame 3725 required: true 3726 type: string 3727 - description: 'Type of datapoint ("tl"/"tp")' 3728 enum: 3729 - tp 3730 - tl 3731 in: query 3732 name: type 3733 required: false 3734 type: string 3735 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 3736 in: query 3737 name: fromDay 3738 required: false 3739 type: string 3740 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 3741 in: query 3742 name: toDay 3743 required: false 3744 type: string 3745 - description: 'Status of datapoint ("deleted"/"active"/"paused"/"spam")' 3746 enum: 3747 - deleted 3748 - active 3749 in: query 3750 name: status 3751 required: false 3752 type: string 3753 - description: A comma separated list of tags you want to filter with. 3754 in: query 3755 name: tag 3756 required: false 3757 type: string 3758 - description: Is the datapoint marked as favourite 3759 in: query 3760 name: favourite 3761 required: false 3762 type: boolean 3763 - description: Field to sort by 3764 in: query 3765 name: sortBy 3766 required: false 3767 type: string 3768 - description: 'Direction of sort "asc" or "desc"' 3769 enum: 3770 - asc 3771 - desc 3772 in: query 3773 name: sortDirection 3774 required: false 3775 type: string 3776 - default: 0 3777 description: Offset where to start from 3778 format: int32 3779 in: query 3780 minLength: 0 3781 name: offset 3782 required: false 3783 type: integer 3784 - default: 20 3785 description: Limit results to this number 3786 format: int32 3787 in: query 3788 maxLength: 0 3789 minLength: 0 3790 name: limit 3791 required: false 3792 type: integer 3793 - description: Filter fields by this pattern 3794 in: query 3795 name: textSearch 3796 required: false 3797 type: string 3798 produces: 3799 - application/json 3800 - text/json 3801 responses: 3802 '200': 3803 description: '' 3804 schema: 3805 $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedSummaryResult' 3806 '401': 3807 description: Unauthorized 3808 '500': 3809 description: Internal Server Error 3810 summary: Retrieve statistics about a subset of datapoints for a timeframe with datapoints data 3811 tags: 3812 - Groups 3813 '/groups/{id}/datapoints': 3814 get: 3815 consumes: [] 3816 deprecated: false 3817 parameters: 3818 - description: Id of the group 3819 format: int64 3820 in: path 3821 name: id 3822 required: true 3823 type: integer 3824 - default: 0 3825 description: Where to start when retrieving elements. Default is 0 if not specified. 3826 format: int32 3827 in: query 3828 minLength: 0 3829 name: offset 3830 required: false 3831 type: integer 3832 - default: 20 3833 description: Maximum elements to retrieve. Default to 20 if not specified. 3834 format: int32 3835 in: query 3836 maxLength: 0 3837 minLength: 0 3838 name: limit 3839 required: false 3840 type: integer 3841 - description: 'Type of the datapoint ("tp"/"tl")' 3842 enum: 3843 - tp 3844 - tl 3845 in: query 3846 name: type 3847 required: false 3848 type: string 3849 - description: Status of the datapoint 3850 enum: 3851 - deleted 3852 - active 3853 - paused 3854 - spam 3855 in: query 3856 name: status 3857 required: false 3858 type: string 3859 - description: A comma separated list of tags you want to filter with. 3860 in: query 3861 name: tags 3862 required: false 3863 type: string 3864 - description: Filter fields by this pattern 3865 in: query 3866 name: textSearch 3867 required: false 3868 type: string 3869 - description: Filter fields by favourite status 3870 in: query 3871 name: onlyFavorites 3872 required: false 3873 type: boolean 3874 - description: Field to sort by 3875 in: query 3876 name: sortBy 3877 required: false 3878 type: string 3879 - description: 'Direction of sort "asc" or "desc"' 3880 enum: 3881 - asc 3882 - desc 3883 in: query 3884 name: sortDirection 3885 required: false 3886 type: string 3887 - description: Exclude datapoints created before this date (YYYYMMDD) 3888 in: query 3889 name: createdAfter 3890 required: false 3891 type: string 3892 - description: Exclude datapoints created after this date (YYYYMMDD) 3893 in: query 3894 name: createdBefore 3895 required: false 3896 type: string 3897 produces: 3898 - application/json 3899 - text/json 3900 responses: 3901 '200': 3902 description: '' 3903 schema: 3904 $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]' 3905 '401': 3906 description: Unauthorized 3907 '404': 3908 description: Not found 3909 '500': 3910 description: Internal Server Error 3911 summary: List of all the datapoints associated to the user in this group. 3912 tags: 3913 - Groups 3914 post: 3915 consumes: 3916 - application/json 3917 - text/json 3918 - application/x-www-form-urlencoded 3919 deprecated: false 3920 parameters: 3921 - description: The id of the group 3922 format: int64 3923 in: path 3924 name: id 3925 required: true 3926 type: integer 3927 - description: The body of the datapoint 3928 in: body 3929 name: value 3930 required: true 3931 schema: 3932 $ref: '#/definitions/Api.Core.Dto.Datapoints.Datapoint' 3933 produces: 3934 - application/json 3935 - text/json 3936 - application/xml 3937 - text/xml 3938 responses: 3939 '200': 3940 description: '' 3941 schema: 3942 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 3943 '401': 3944 description: Unauthorized 3945 '404': 3946 description: Not found 3947 '500': 3948 description: Internal Server Error 3949 summary: Create a datapoint in this group 3950 tags: 3951 - Groups 3952 '/groups/{id}/datapoints/count': 3953 get: 3954 consumes: [] 3955 deprecated: false 3956 parameters: 3957 - description: Id of the group 3958 format: int64 3959 in: path 3960 name: id 3961 required: true 3962 type: integer 3963 - description: 'Type of the datapoint ("tp"/"tl")' 3964 enum: 3965 - tp 3966 - tl 3967 in: query 3968 name: type 3969 required: false 3970 type: string 3971 - description: Status of the datapoint 3972 enum: 3973 - deleted 3974 - active 3975 - paused 3976 - spam 3977 in: query 3978 name: status 3979 required: false 3980 type: string 3981 - description: A comma separated list of tags you want to filter with. 3982 in: query 3983 name: tags 3984 required: false 3985 type: string 3986 - description: Filter fields by this pattern 3987 in: query 3988 name: textSearch 3989 required: false 3990 type: string 3991 - description: Filter fields by favourite status 3992 in: query 3993 name: onlyFavorites 3994 required: false 3995 type: boolean 3996 - description: Exclude datapoints created before this date (YYYYMMDD) 3997 in: query 3998 name: createdAfter 3999 required: false 4000 type: string 4001 - description: Exclude datapoints created after this date (YYYYMMDD) 4002 in: query 4003 name: createdBefore 4004 required: false 4005 type: string 4006 produces: 4007 - application/json 4008 - text/json 4009 - application/xml 4010 - text/xml 4011 responses: 4012 '200': 4013 description: '' 4014 schema: 4015 $ref: '#/definitions/Api.Core.Responses.CountResponce' 4016 '401': 4017 description: Unauthorized 4018 '404': 4019 description: Not found 4020 '500': 4021 description: Internal Server Error 4022 summary: Count the datapoints associated to the user in this group. 4023 tags: 4024 - Groups 4025 '/groups/{id}/favourite': 4026 put: 4027 consumes: [] 4028 deprecated: false 4029 parameters: 4030 - description: Id of the group 4031 format: int64 4032 in: path 4033 name: id 4034 required: true 4035 type: integer 4036 produces: 4037 - application/json 4038 - text/json 4039 - application/xml 4040 - text/xml 4041 responses: 4042 '200': 4043 description: '' 4044 schema: 4045 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 4046 '401': 4047 description: Unauthorized 4048 '403': 4049 description: Forbidden 4050 '404': 4051 description: Not found 4052 '500': 4053 description: Internal Server Error 4054 summary: 'Fast switch the "favourite" field of a group' 4055 tags: 4056 - Groups 4057 '/groups/{id}/hits': 4058 get: 4059 consumes: [] 4060 deprecated: false 4061 parameters: 4062 - description: Id of the group 4063 format: int64 4064 in: path 4065 name: id 4066 required: true 4067 type: integer 4068 - description: Timeframe of the request. See list at $timeframeList 4069 enum: 4070 - yesterday 4071 - last7 4072 - last30 4073 - lastmonth 4074 - currentmonth 4075 - previousmonth 4076 - last90 4077 - last120 4078 - last180 4079 - custom 4080 in: query 4081 name: timeframe 4082 required: true 4083 type: string 4084 - description: Limit results to this number 4085 format: int32 4086 in: query 4087 maxLength: 0 4088 minLength: 0 4089 name: limit 4090 required: false 4091 type: integer 4092 - description: "Offset where to start from (it's the lastKey field in the response object)" 4093 in: query 4094 name: offset 4095 required: false 4096 type: string 4097 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 4098 in: query 4099 name: fromDay 4100 required: false 4101 type: string 4102 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 4103 in: query 4104 name: toDay 4105 required: false 4106 type: string 4107 - description: 'Filter event type ("spiders"/"uniques"/"nonuniques"/"conversions")' 4108 enum: 4109 - spiders 4110 - uniques 4111 - nonuniques 4112 - conversions 4113 in: query 4114 name: filter 4115 required: false 4116 type: string 4117 produces: 4118 - application/json 4119 - text/json 4120 responses: 4121 '200': 4122 description: '' 4123 schema: 4124 $ref: '#/definitions/Api.Core.Dto.ClickStream.HitListPage' 4125 '401': 4126 description: Unauthorized 4127 '500': 4128 description: Internal Server Error 4129 summary: Retrieve the list of events related to this group. 4130 tags: 4131 - Groups 4132 '/groups/{id}/notes': 4133 put: 4134 consumes: 4135 - application/json 4136 - text/json 4137 - application/xml 4138 - text/xml 4139 - application/x-www-form-urlencoded 4140 deprecated: false 4141 parameters: 4142 - description: Id of the group 4143 format: int64 4144 in: path 4145 name: id 4146 required: true 4147 type: integer 4148 - description: Patch requests 4149 in: body 4150 name: note 4151 required: true 4152 schema: 4153 $ref: '#/definitions/Api.Core.Requests.GenericTextPatch' 4154 produces: 4155 - application/json 4156 - text/json 4157 - application/xml 4158 - text/xml 4159 responses: 4160 '200': 4161 description: '' 4162 schema: 4163 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 4164 '401': 4165 description: Unauthorized 4166 '403': 4167 description: Forbidden 4168 '404': 4169 description: Not found 4170 '500': 4171 description: Internal Server Error 4172 summary: 'Fast patch the "notes" field of a group' 4173 tags: 4174 - Groups 4175 '/groups/{id}/reports': 4176 get: 4177 consumes: [] 4178 deprecated: false 4179 parameters: 4180 - description: Id of the group 4181 format: int64 4182 in: path 4183 name: id 4184 required: true 4185 type: integer 4186 - description: Type of the report. 4187 enum: 4188 - browsers 4189 - browsersfamilies 4190 - platforms 4191 - cities 4192 - countries 4193 - isps 4194 - ips 4195 - oss 4196 - ossfamilies 4197 - keywords 4198 - referrers 4199 - destinations 4200 - languages 4201 - params 4202 in: query 4203 name: type 4204 required: true 4205 type: string 4206 - description: Timeframe of the request. See list at $timeframeList 4207 enum: 4208 - yesterday 4209 - last7 4210 - last30 4211 - lastmonth 4212 - currentmonth 4213 - previousmonth 4214 - last90 4215 - last120 4216 - last180 4217 - beginning 4218 - custom 4219 in: query 4220 name: timeframe 4221 required: true 4222 type: string 4223 - description: Type of the event you want to filter this report with. By default no filter is applied. 4224 enum: 4225 - clicks 4226 - views 4227 in: query 4228 name: hittype 4229 required: false 4230 type: string 4231 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 4232 in: query 4233 name: fromDay 4234 required: false 4235 type: string 4236 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 4237 in: query 4238 name: toDay 4239 required: false 4240 type: string 4241 produces: 4242 - application/json 4243 - text/json 4244 responses: 4245 '200': 4246 description: '' 4247 schema: 4248 $ref: '#/definitions/Api.Core.Dto.Tops.Top' 4249 '401': 4250 description: Forbidden 4251 '404': 4252 description: Not found 4253 '500': 4254 description: Internal Server Error 4255 summary: Retrieve a top report connected to this group 4256 tags: 4257 - Groups 4258 /hits: 4259 get: 4260 consumes: [] 4261 deprecated: false 4262 parameters: 4263 - description: Timeframe of the request. See list at $timeframeList 4264 enum: 4265 - yesterday 4266 - last7 4267 - last30 4268 - lastmonth 4269 - currentmonth 4270 - previousmonth 4271 - last90 4272 - last120 4273 - last180 4274 - custom 4275 in: query 4276 name: timeframe 4277 required: true 4278 type: string 4279 - description: Limit results to this number 4280 format: int32 4281 in: query 4282 name: limit 4283 required: false 4284 type: integer 4285 - description: "Offset where to start from (it's the lastKey field in the response object)" 4286 in: query 4287 name: offset 4288 required: false 4289 type: string 4290 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 4291 in: query 4292 name: fromDay 4293 required: false 4294 type: string 4295 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 4296 in: query 4297 name: toDay 4298 required: false 4299 type: string 4300 - description: 'Filter event type ("spiders"/"uniques"/"nonuniques"/"conversions")' 4301 enum: 4302 - spiders 4303 - uniques 4304 - nonuniques 4305 - conversions 4306 in: query 4307 name: filter 4308 required: false 4309 type: string 4310 produces: 4311 - application/json 4312 - text/json 4313 responses: 4314 '200': 4315 description: '' 4316 schema: 4317 $ref: '#/definitions/Api.Core.Dto.ClickStream.HitListPage' 4318 '401': 4319 description: Unauthorized 4320 '500': 4321 description: Internal Server Error 4322 summary: Retrieve the list of events related to this account. 4323 tags: 4324 - Hits 4325 /me: 4326 get: 4327 consumes: [] 4328 deprecated: false 4329 produces: 4330 - application/json 4331 - text/json 4332 - application/xml 4333 - text/xml 4334 responses: 4335 '200': 4336 description: '' 4337 schema: 4338 $ref: '#/definitions/Api.Core.Dto.Accounting.User' 4339 '401': 4340 description: Unauthorized 4341 '500': 4342 description: Internal Server Error 4343 summary: Retrieve current account data 4344 tags: 4345 - Me 4346 /me/plan: 4347 get: 4348 consumes: [] 4349 deprecated: false 4350 produces: 4351 - application/json 4352 - text/json 4353 - application/xml 4354 - text/xml 4355 responses: 4356 '200': 4357 description: '' 4358 schema: 4359 $ref: '#/definitions/Api.Core.Dto.Accounting.Plan' 4360 '401': 4361 description: Unauthorized 4362 '500': 4363 description: Internal Server Error 4364 summary: Retrieve current account plan 4365 tags: 4366 - Me 4367 /reports: 4368 get: 4369 consumes: [] 4370 deprecated: false 4371 parameters: 4372 - description: Type of the report. 4373 enum: 4374 - browsers 4375 - browsersfamilies 4376 - platforms 4377 - cities 4378 - countries 4379 - isps 4380 - ips 4381 - oss 4382 - ossfamilies 4383 - keywords 4384 - referrers 4385 - destinations 4386 - languages 4387 - params 4388 in: query 4389 name: type 4390 required: true 4391 type: string 4392 - description: Timeframe of the request. See list at $timeframeList 4393 enum: 4394 - yesterday 4395 - last7 4396 - last30 4397 - lastmonth 4398 - currentmonth 4399 - previousmonth 4400 - last90 4401 - last120 4402 - last180 4403 - beginning 4404 - custom 4405 in: query 4406 name: timeframe 4407 required: true 4408 type: string 4409 - description: Type of the event you want to filter this report with. By default no filter is applied. 4410 in: query 4411 name: hittype 4412 required: false 4413 type: string 4414 - description: 'Filter by this group id (mutually exclusive with "datapoint" and "conversion")' 4415 format: int64 4416 in: query 4417 name: group 4418 required: false 4419 type: integer 4420 - description: 'Filter by this datapoint id (mutually exclusive with "group" and "conversion")' 4421 format: int64 4422 in: query 4423 name: datapoint 4424 required: false 4425 type: integer 4426 - description: 'Filter by this conversion id (mutually exclusive with "datapoint" and "group")' 4427 format: int64 4428 in: query 4429 name: conversion 4430 required: false 4431 type: integer 4432 - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' 4433 in: query 4434 name: fromDay 4435 required: false 4436 type: string 4437 - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' 4438 in: query 4439 name: toDay 4440 required: false 4441 type: string 4442 produces: 4443 - application/json 4444 - text/json 4445 responses: 4446 '200': 4447 description: '' 4448 schema: 4449 $ref: '#/definitions/Api.Core.Dto.Tops.Top' 4450 '401': 4451 description: Forbidden 4452 '404': 4453 description: Not found 4454 '500': 4455 description: Internal Server Error 4456 summary: Retrieve a top report 4457 tags: 4458 - Reports 4459 /retargeting: 4460 get: 4461 consumes: [] 4462 deprecated: false 4463 parameters: 4464 - default: 0 4465 description: Where to start when retrieving elements. Default is 0 if not specified. 4466 format: int32 4467 in: query 4468 minLength: 0 4469 name: offset 4470 required: false 4471 type: integer 4472 - default: 20 4473 description: Maximum elements to retrieve. Default to 20 if not specified. 4474 format: int32 4475 in: query 4476 maxLength: 0 4477 minLength: 0 4478 name: limit 4479 required: false 4480 type: integer 4481 produces: 4482 - application/json 4483 - text/json 4484 responses: 4485 '200': 4486 description: '' 4487 schema: 4488 $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]' 4489 '401': 4490 description: Unauthorized 4491 '404': 4492 description: Not found 4493 '500': 4494 description: Internal Server Error 4495 summary: List of all the retargeting scripts associated to the user 4496 tags: 4497 - Retargeting 4498 post: 4499 consumes: 4500 - application/json 4501 - text/json 4502 - application/xml 4503 - text/xml 4504 - application/x-www-form-urlencoded 4505 deprecated: false 4506 parameters: 4507 - description: The body of the retargeting script 4508 in: body 4509 name: value 4510 required: true 4511 schema: 4512 $ref: '#/definitions/Api.Core.Dto.Retargeting.RetargetingScript' 4513 produces: 4514 - application/json 4515 - text/json 4516 - application/xml 4517 - text/xml 4518 responses: 4519 '200': 4520 description: '' 4521 schema: 4522 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 4523 '401': 4524 description: Unauthorized 4525 '404': 4526 description: Not found 4527 '500': 4528 description: Internal Server Error 4529 summary: Creates a retargeting script 4530 tags: 4531 - Retargeting 4532 /retargeting/count: 4533 get: 4534 consumes: [] 4535 deprecated: false 4536 produces: 4537 - application/json 4538 - text/json 4539 - application/xml 4540 - text/xml 4541 responses: 4542 '200': 4543 description: '' 4544 schema: 4545 $ref: '#/definitions/Api.Core.Responses.CountResponce' 4546 '401': 4547 description: Unauthorized 4548 '500': 4549 description: Internal Server Error 4550 summary: Retrieve count of retargeting scripts 4551 tags: 4552 - Retargeting 4553 '/retargeting/{id}': 4554 delete: 4555 consumes: [] 4556 deprecated: false 4557 parameters: 4558 - description: The id of the retargeting script 4559 format: int64 4560 in: path 4561 name: id 4562 required: true 4563 type: integer 4564 produces: 4565 - application/json 4566 - text/json 4567 - application/xml 4568 - text/xml 4569 responses: 4570 '200': 4571 description: '' 4572 schema: 4573 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 4574 '401': 4575 description: Unauthorized 4576 '404': 4577 description: Not found 4578 '500': 4579 description: Internal Server Error 4580 summary: Deletes a retargeting script (and remove associations) 4581 tags: 4582 - Retargeting 4583 get: 4584 consumes: [] 4585 deprecated: false 4586 parameters: 4587 - description: The id of the retargeting script 4588 format: int64 4589 in: path 4590 name: id 4591 required: true 4592 type: integer 4593 produces: 4594 - application/json 4595 - text/json 4596 - application/xml 4597 - text/xml 4598 responses: 4599 '200': 4600 description: '' 4601 schema: 4602 $ref: '#/definitions/Api.Core.Dto.Retargeting.RetargetingScript' 4603 '401': 4604 description: Unauthorized 4605 '404': 4606 description: Not found 4607 '500': 4608 description: Internal Server Error 4609 summary: Get a retargeting script object 4610 tags: 4611 - Retargeting 4612 post: 4613 consumes: 4614 - application/json 4615 - text/json 4616 - application/xml 4617 - text/xml 4618 - application/x-www-form-urlencoded 4619 deprecated: false 4620 parameters: 4621 - description: The id of the retargeting script 4622 format: int64 4623 in: path 4624 name: id 4625 required: true 4626 type: integer 4627 - description: The body of the retargeting script 4628 in: body 4629 name: value 4630 required: true 4631 schema: 4632 $ref: '#/definitions/Api.Core.Dto.Retargeting.RetargetingScript' 4633 produces: 4634 - application/json 4635 - text/json 4636 - application/xml 4637 - text/xml 4638 responses: 4639 '200': 4640 description: '' 4641 schema: 4642 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 4643 '401': 4644 description: Unauthorized 4645 '404': 4646 description: Not found 4647 '500': 4648 description: Internal Server Error 4649 summary: Updates a retargeting script 4650 tags: 4651 - Retargeting 4652 '/retargeting/{id}/datapoints': 4653 get: 4654 consumes: [] 4655 deprecated: false 4656 parameters: 4657 - description: Id of the retargeting script 4658 format: int64 4659 in: path 4660 name: id 4661 required: true 4662 type: integer 4663 - default: 0 4664 description: Where to start when retrieving elements. Default is 0 if not specified. 4665 format: int32 4666 in: query 4667 minLength: 0 4668 name: offset 4669 required: false 4670 type: integer 4671 - default: 20 4672 description: Maximum elements to retrieve. Default to 20 if not specified. 4673 format: int32 4674 in: query 4675 maxLength: 0 4676 minLength: 0 4677 name: limit 4678 required: false 4679 type: integer 4680 - description: Status of the datapoint 4681 enum: 4682 - deleted 4683 - active 4684 - paused 4685 - spam 4686 in: query 4687 name: status 4688 required: false 4689 type: string 4690 - description: A comma separated list of tags you want to filter with. 4691 in: query 4692 name: tags 4693 required: false 4694 type: string 4695 - description: Filter fields by this pattern 4696 in: query 4697 name: textSearch 4698 required: false 4699 type: string 4700 - description: Filter fields by favourite status 4701 in: query 4702 name: onlyFavorites 4703 required: false 4704 type: boolean 4705 - description: Field to sort by 4706 in: query 4707 name: sortBy 4708 required: false 4709 type: string 4710 - description: 'Direction of sort "asc" or "desc"' 4711 enum: 4712 - asc 4713 - desc 4714 in: query 4715 name: sortDirection 4716 required: false 4717 type: string 4718 - description: Exclude datapoints created before this date (YYYYMMDD) 4719 in: query 4720 name: createdAfter 4721 required: false 4722 type: string 4723 - description: Exclude datapoints created after this date (YYYYMMDD) 4724 in: query 4725 name: createdBefore 4726 required: false 4727 type: string 4728 produces: 4729 - application/json 4730 - text/json 4731 responses: 4732 '200': 4733 description: '' 4734 schema: 4735 $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]' 4736 '401': 4737 description: Unauthorized 4738 '404': 4739 description: Not found 4740 '500': 4741 description: Internal Server Error 4742 summary: List of all the datapoints associated to the retargeting script. 4743 tags: 4744 - Retargeting 4745 '/retargeting/{id}/datapoints/count': 4746 get: 4747 consumes: [] 4748 deprecated: false 4749 parameters: 4750 - description: Id of the group 4751 format: int64 4752 in: path 4753 name: id 4754 required: true 4755 type: integer 4756 - description: Status of the datapoint 4757 enum: 4758 - deleted 4759 - active 4760 - paused 4761 - spam 4762 in: query 4763 name: status 4764 required: false 4765 type: string 4766 - description: A comma separated list of tags you want to filter with. 4767 in: query 4768 name: tags 4769 required: false 4770 type: string 4771 - description: Filter fields by this pattern 4772 in: query 4773 name: textSearch 4774 required: false 4775 type: string 4776 - description: Filter fields by favourite status 4777 in: query 4778 name: onlyFavorites 4779 required: false 4780 type: boolean 4781 - description: Exclude datapoints created before this date (YYYYMMDD) 4782 in: query 4783 name: createdAfter 4784 required: false 4785 type: string 4786 - description: Exclude datapoints created after this date (YYYYMMDD) 4787 in: query 4788 name: createdBefore 4789 required: false 4790 type: string 4791 produces: 4792 - application/json 4793 - text/json 4794 - application/xml 4795 - text/xml 4796 responses: 4797 '200': 4798 description: '' 4799 schema: 4800 $ref: '#/definitions/Api.Core.Responses.CountResponce' 4801 '401': 4802 description: Unauthorized 4803 '404': 4804 description: Not found 4805 '500': 4806 description: Internal Server Error 4807 summary: Count the datapoints associated to the retargeting script. 4808 tags: 4809 - Retargeting 4810 /tags: 4811 get: 4812 consumes: [] 4813 deprecated: false 4814 parameters: 4815 - default: 0 4816 description: Where to start when retrieving elements. Default is 0 if not specified. 4817 format: int32 4818 in: query 4819 minLength: 0 4820 name: offset 4821 required: false 4822 type: integer 4823 - default: 20 4824 description: Maximum elements to retrieve. Default to 20 if not specified. 4825 format: int32 4826 in: query 4827 maxLength: 0 4828 minLength: 0 4829 name: limit 4830 required: false 4831 type: integer 4832 - description: Name of the tag 4833 in: query 4834 name: name 4835 required: false 4836 type: string 4837 - description: Comma separated list of datapoints id to filter by 4838 in: query 4839 name: datapoints 4840 required: false 4841 type: string 4842 - description: Comma separated list of groups id to filter by 4843 in: query 4844 name: groups 4845 required: false 4846 type: string 4847 - description: Type of entity related to the tag 4848 enum: 4849 - tp 4850 - tl 4851 - dp 4852 - gr 4853 in: query 4854 name: type 4855 required: false 4856 type: string 4857 produces: 4858 - application/json 4859 - text/json 4860 responses: 4861 '200': 4862 description: '' 4863 schema: 4864 $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]' 4865 '401': 4866 description: Unauthorized 4867 '404': 4868 description: Not found 4869 '500': 4870 description: Internal Server Error 4871 summary: List of all the groups associated to the user filtered by this tag. 4872 tags: 4873 - Tags 4874 post: 4875 consumes: 4876 - application/json 4877 - text/json 4878 - application/x-www-form-urlencoded 4879 deprecated: false 4880 parameters: 4881 - description: The body of the tag 4882 in: body 4883 name: value 4884 required: true 4885 schema: 4886 $ref: '#/definitions/Api.Core.Dto.Tags.Tag' 4887 produces: 4888 - application/json 4889 - text/json 4890 - application/xml 4891 - text/xml 4892 responses: 4893 '200': 4894 description: '' 4895 schema: 4896 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 4897 '401': 4898 description: Unauthorized 4899 '404': 4900 description: Not found 4901 '500': 4902 description: Internal Server Error 4903 summary: Create a tag 4904 tags: 4905 - Tags 4906 /tags/count: 4907 get: 4908 consumes: [] 4909 deprecated: false 4910 parameters: 4911 - description: Name of the tag 4912 in: query 4913 name: name 4914 required: false 4915 type: string 4916 - description: Comma separated list of datapoints id to filter by 4917 in: query 4918 name: datapoints 4919 required: false 4920 type: string 4921 - description: Comma separated list of groups id to filter by 4922 in: query 4923 name: groups 4924 required: false 4925 type: string 4926 - description: Type of entity related to the tag 4927 enum: 4928 - tp 4929 - tl 4930 - dp 4931 - gr 4932 in: query 4933 name: type 4934 required: false 4935 type: string 4936 produces: 4937 - application/json 4938 - text/json 4939 responses: 4940 '200': 4941 description: '' 4942 schema: 4943 $ref: '#/definitions/System.Object' 4944 '401': 4945 description: Unauthorized 4946 '404': 4947 description: Not found 4948 '500': 4949 description: Internal Server Error 4950 summary: List of all the groups associated to the user filtered by this tag. 4951 tags: 4952 - Tags 4953 '/tags/{tagId}': 4954 delete: 4955 consumes: [] 4956 deprecated: false 4957 parameters: 4958 - description: Id of the tag 4959 format: int64 4960 in: path 4961 name: tagId 4962 required: true 4963 type: integer 4964 produces: 4965 - application/json 4966 - text/json 4967 responses: 4968 '200': 4969 description: '' 4970 schema: 4971 $ref: '#/definitions/System.Object' 4972 '401': 4973 description: Unauthorized 4974 '500': 4975 description: Internal Server Error 4976 summary: Delete a tag 4977 tags: 4978 - Tags 4979 get: 4980 consumes: [] 4981 deprecated: false 4982 parameters: 4983 - description: Id of the tag 4984 format: int64 4985 in: path 4986 name: tagId 4987 required: true 4988 type: integer 4989 produces: 4990 - application/json 4991 - text/json 4992 responses: 4993 '200': 4994 description: '' 4995 schema: 4996 $ref: '#/definitions/Api.Core.Dto.Tags.Tag' 4997 '401': 4998 description: Unauthorized 4999 '500': 5000 description: Internal Server Error 5001 summary: Retrieve a tag 5002 tags: 5003 - Tags 5004 '/tags/{tagId}/datapoints': 5005 delete: 5006 consumes: [] 5007 deprecated: false 5008 parameters: 5009 - description: Id of the tag 5010 format: int64 5011 in: path 5012 name: tagId 5013 required: true 5014 type: integer 5015 produces: 5016 - application/json 5017 - text/json 5018 - application/xml 5019 - text/xml 5020 responses: 5021 '200': 5022 description: '' 5023 schema: 5024 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 5025 '401': 5026 description: Unauthorized 5027 '500': 5028 description: Internal Server Error 5029 summary: Delete the association of this tag with all datapoints 5030 tags: 5031 - Tags 5032 get: 5033 consumes: [] 5034 deprecated: false 5035 parameters: 5036 - description: Id of the tag. 5037 format: int64 5038 in: path 5039 name: tagId 5040 required: true 5041 type: integer 5042 - default: 0 5043 description: Where to start when retrieving elements. Default is 0 if not specified. 5044 format: int32 5045 in: query 5046 minLength: 0 5047 name: offset 5048 required: false 5049 type: integer 5050 - default: 20 5051 description: Maximum elements to retrieve. Default to 20 if not specified. 5052 format: int32 5053 in: query 5054 maxLength: 0 5055 minLength: 0 5056 name: limit 5057 required: false 5058 type: integer 5059 - description: 'Type of the datapoint ("tp"/"tl")' 5060 enum: 5061 - tp 5062 - tl 5063 in: query 5064 name: type 5065 required: false 5066 type: string 5067 - description: Status of the datapoint 5068 enum: 5069 - deleted 5070 - active 5071 - paused 5072 - spam 5073 in: query 5074 name: status 5075 required: false 5076 type: string 5077 - description: Filter fields by this pattern 5078 in: query 5079 name: textSearch 5080 required: false 5081 type: string 5082 - description: Exclude datapoints created before this date (YYYYMMDD) 5083 in: query 5084 name: createdAfter 5085 required: false 5086 type: string 5087 - description: Exclude datapoints created after this date (YYYYMMDD) 5088 in: query 5089 name: createdBefore 5090 required: false 5091 type: string 5092 produces: 5093 - application/json 5094 - text/json 5095 responses: 5096 '200': 5097 description: '' 5098 schema: 5099 $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]' 5100 '401': 5101 description: Unauthorized 5102 '404': 5103 description: Not found 5104 '500': 5105 description: Internal Server Error 5106 summary: List of all the datapoints associated to the user filtered by this tag 5107 tags: 5108 - Tags 5109 '/tags/{tagId}/datapoints/count': 5110 get: 5111 consumes: [] 5112 deprecated: false 5113 parameters: 5114 - description: Id of the tag. 5115 format: int64 5116 in: path 5117 name: tagId 5118 required: true 5119 type: integer 5120 - description: 'Type of the datapoint ("tp"/"tl")' 5121 enum: 5122 - tp 5123 - tl 5124 in: query 5125 name: type 5126 required: false 5127 type: string 5128 - description: Status of the datapoint 5129 enum: 5130 - deleted 5131 - active 5132 - paused 5133 - spam 5134 in: query 5135 name: status 5136 required: false 5137 type: string 5138 - description: Filter fields by this pattern 5139 in: query 5140 name: textSearch 5141 required: false 5142 type: string 5143 - description: Exclude datapoints created before this date (YYYYMMDD) 5144 in: query 5145 name: createdAfter 5146 required: false 5147 type: string 5148 - description: Exclude datapoints created after this date (YYYYMMDD) 5149 in: query 5150 name: createdBefore 5151 required: false 5152 type: string 5153 produces: 5154 - application/json 5155 - text/json 5156 - application/xml 5157 - text/xml 5158 responses: 5159 '200': 5160 description: '' 5161 schema: 5162 $ref: '#/definitions/Api.Core.Responses.CountResponce' 5163 '401': 5164 description: Unauthorized 5165 '404': 5166 description: Not found 5167 '500': 5168 description: Internal Server Error 5169 summary: Count the datapoints associated to the user filtered by this tag 5170 tags: 5171 - Tags 5172 '/tags/{tagId}/datapoints/patch': 5173 put: 5174 consumes: 5175 - application/json 5176 - text/json 5177 - application/xml 5178 - text/xml 5179 - application/x-www-form-urlencoded 5180 deprecated: false 5181 parameters: 5182 - description: Id of the tag 5183 format: int64 5184 in: path 5185 name: tagId 5186 required: true 5187 type: integer 5188 - description: The body patch 5189 in: body 5190 name: data 5191 required: true 5192 schema: 5193 $ref: '#/definitions/Api.Core.Requests.PatchBody' 5194 produces: 5195 - application/json 5196 - text/json 5197 - application/xml 5198 - text/xml 5199 responses: 5200 '200': 5201 description: '' 5202 schema: 5203 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 5204 '401': 5205 description: Unauthorized 5206 '404': 5207 description: Not found 5208 '500': 5209 description: Internal Server Error 5210 summary: Associate/Deassociate a tag with a datapoint 5211 tags: 5212 - Tags 5213 '/tags/{tagId}/groups': 5214 delete: 5215 consumes: [] 5216 deprecated: false 5217 parameters: 5218 - description: Id of the tag 5219 format: int64 5220 in: path 5221 name: tagId 5222 required: true 5223 type: integer 5224 produces: 5225 - application/json 5226 - text/json 5227 - application/xml 5228 - text/xml 5229 responses: 5230 '200': 5231 description: '' 5232 schema: 5233 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 5234 '401': 5235 description: Unauthorized 5236 '500': 5237 description: Internal Server Error 5238 summary: Delete the association of this tag with all groups 5239 tags: 5240 - Tags 5241 get: 5242 consumes: [] 5243 deprecated: false 5244 parameters: 5245 - description: Id of the tag. 5246 format: int64 5247 in: path 5248 name: tagId 5249 required: true 5250 type: integer 5251 - default: 0 5252 description: Where to start when retrieving elements. Default is 0 if not specified. 5253 format: int32 5254 in: query 5255 minLength: 0 5256 name: offset 5257 required: false 5258 type: integer 5259 - default: 20 5260 description: Maximum elements to retrieve. Default to 20 if not specified. 5261 format: int32 5262 in: query 5263 maxLength: 0 5264 minLength: 0 5265 name: limit 5266 required: false 5267 type: integer 5268 - description: Status of the datapoint 5269 enum: 5270 - deleted 5271 - active 5272 in: query 5273 name: status 5274 required: false 5275 type: string 5276 - description: Filter fields by this pattern 5277 in: query 5278 name: textSearch 5279 required: false 5280 type: string 5281 - description: Exclude groups created before this date (YYYYMMDD) 5282 in: query 5283 name: createdAfter 5284 required: false 5285 type: string 5286 - description: Exclude groups created after this date (YYYYMMDD) 5287 in: query 5288 name: createdBefore 5289 required: false 5290 type: string 5291 produces: 5292 - application/json 5293 - text/json 5294 responses: 5295 '200': 5296 description: '' 5297 schema: 5298 $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]' 5299 '401': 5300 description: Unauthorized 5301 '404': 5302 description: Not found 5303 '500': 5304 description: Internal Server Error 5305 summary: List of all the groups associated to the user filtered by this tag. 5306 tags: 5307 - Tags 5308 '/tags/{tagId}/groups/count': 5309 get: 5310 consumes: [] 5311 deprecated: false 5312 parameters: 5313 - description: Id of the tag. 5314 format: int64 5315 in: path 5316 name: tagId 5317 required: true 5318 type: integer 5319 - description: Status of the datapoint 5320 enum: 5321 - deleted 5322 - active 5323 in: query 5324 name: status 5325 required: false 5326 type: string 5327 - description: Filter fields by this pattern 5328 in: query 5329 name: textSearch 5330 required: false 5331 type: string 5332 - description: Exclude groups created before this date (YYYYMMDD) 5333 in: query 5334 name: createdAfter 5335 required: false 5336 type: string 5337 - description: Exclude groups created after this date (YYYYMMDD) 5338 in: query 5339 name: createdBefore 5340 required: false 5341 type: string 5342 produces: 5343 - application/json 5344 - text/json 5345 - application/xml 5346 - text/xml 5347 responses: 5348 '200': 5349 description: '' 5350 schema: 5351 $ref: '#/definitions/Api.Core.Responses.CountResponce' 5352 '401': 5353 description: Unauthorized 5354 '404': 5355 description: Not found 5356 '500': 5357 description: Internal Server Error 5358 summary: Count the groups associated to the user filtered by this tag 5359 tags: 5360 - Tags 5361 '/tags/{tagId}/groups/patch': 5362 put: 5363 consumes: 5364 - application/json 5365 - text/json 5366 - application/xml 5367 - text/xml 5368 - application/x-www-form-urlencoded 5369 deprecated: false 5370 parameters: 5371 - description: Id of the tag 5372 format: int64 5373 in: path 5374 name: tagId 5375 required: true 5376 type: integer 5377 - description: The body patch 5378 in: body 5379 name: data 5380 required: true 5381 schema: 5382 $ref: '#/definitions/Api.Core.Requests.PatchBody' 5383 produces: 5384 - application/json 5385 - text/json 5386 - application/xml 5387 - text/xml 5388 responses: 5389 '200': 5390 description: '' 5391 schema: 5392 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 5393 '401': 5394 description: Unauthorized 5395 '404': 5396 description: Not found 5397 '500': 5398 description: Internal Server Error 5399 summary: Associate/Deassociate a tag with a group 5400 tags: 5401 - Tags 5402 '/tags/{tagId}/name': 5403 put: 5404 consumes: 5405 - application/json 5406 - text/json 5407 - application/xml 5408 - text/xml 5409 - application/x-www-form-urlencoded 5410 deprecated: false 5411 parameters: 5412 - description: Id of the tag 5413 format: int64 5414 in: path 5415 name: tagId 5416 required: true 5417 type: integer 5418 - description: The body patch 5419 in: body 5420 name: data 5421 required: true 5422 schema: 5423 $ref: '#/definitions/Api.Core.Requests.GenericTextPatch' 5424 produces: 5425 - application/json 5426 - text/json 5427 - application/xml 5428 - text/xml 5429 responses: 5430 '200': 5431 description: '' 5432 schema: 5433 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 5434 '401': 5435 description: Unauthorized 5436 '500': 5437 description: Internal Server Error 5438 summary: Fast patch a tag name 5439 tags: 5440 - Tags 5441 definitions: 5442 Api.Core.Dto.Accounting.ConversionOptions: 5443 properties: 5444 hideComCost: 5445 type: boolean 5446 hideCost: 5447 type: boolean 5448 hideCount: 5449 type: boolean 5450 hideParams: 5451 type: boolean 5452 hideValue: 5453 type: boolean 5454 percentCommission: 5455 format: int32 5456 type: integer 5457 percentValue: 5458 format: int32 5459 type: integer 5460 type: object 5461 Api.Core.Dto.Accounting.DomainWhitelistEntry: 5462 properties: 5463 id: 5464 type: string 5465 name: 5466 type: string 5467 type: object 5468 Api.Core.Dto.Accounting.ExtendedGrants: 5469 properties: 5470 allowAllGrants: 5471 type: boolean 5472 allowGroupCreation: 5473 type: boolean 5474 type: object 5475 Api.Core.Dto.Accounting.Guest: 5476 properties: 5477 apiKey: 5478 type: string 5479 conversionOptions: 5480 $ref: '#/definitions/Api.Core.Dto.Accounting.ConversionOptions' 5481 creationDate: 5482 description: ' (A date in "YmdHis" format)' 5483 example: '20120203120530' 5484 type: string 5485 currentGrant: 5486 $ref: '#/definitions/Api.Core.Dto.Grants.Grant' 5487 dateFormat: 5488 type: string 5489 decimalSeparator: 5490 type: string 5491 email: 5492 type: string 5493 extendedGrants: 5494 $ref: '#/definitions/Api.Core.Dto.Accounting.ExtendedGrants' 5495 groupGrants: 5496 format: int64 5497 type: integer 5498 hitOptions: 5499 $ref: '#/definitions/Api.Core.Dto.Accounting.HitOptions' 5500 id: 5501 format: int64 5502 type: integer 5503 key: 5504 type: string 5505 language: 5506 type: string 5507 loginCount: 5508 format: int32 5509 type: integer 5510 name: 5511 type: string 5512 notes: 5513 type: string 5514 numberGroupSeparator: 5515 type: string 5516 password: 5517 type: string 5518 timeFormat: 5519 enum: 5520 - AmPm 5521 - H24 5522 type: string 5523 timeZone: 5524 format: int32 5525 type: integer 5526 timeframeMinDate: 5527 description: ' (A date in "YmdHis" format)' 5528 example: '20120203120530' 5529 type: string 5530 timezonename: 5531 type: string 5532 tlGrants: 5533 format: int64 5534 type: integer 5535 tpGrants: 5536 format: int64 5537 type: integer 5538 userName: 5539 type: string 5540 type: object 5541 Api.Core.Dto.Accounting.HitOptions: 5542 properties: 5543 hideReferrer: 5544 type: boolean 5545 type: object 5546 Api.Core.Dto.Accounting.IpBlacklistEntry: 5547 properties: 5548 id: 5549 type: string 5550 ip: 5551 type: string 5552 type: object 5553 Api.Core.Dto.Accounting.Plan: 5554 properties: 5555 allowedPersonalDomains: 5556 format: int32 5557 type: integer 5558 allowedPersonalUrls: 5559 format: int32 5560 type: integer 5561 billingPeriodEnd: 5562 description: ' (A date in "YmdHis" format)' 5563 example: '20120203120530' 5564 type: string 5565 billingPeriodStart: 5566 description: ' (A date in "YmdHis" format)' 5567 example: '20120203120530' 5568 type: string 5569 bonusMonthlyEvents: 5570 format: int64 5571 type: integer 5572 maximumDatapoints: 5573 format: int64 5574 type: integer 5575 maximumGuests: 5576 format: int64 5577 type: integer 5578 monthlyEvents: 5579 format: int64 5580 type: integer 5581 name: 5582 type: string 5583 price: 5584 format: double 5585 type: number 5586 profileId: 5587 format: int64 5588 type: integer 5589 recurring: 5590 type: boolean 5591 recurringPeriod: 5592 format: int32 5593 type: integer 5594 usedDatapoints: 5595 format: int64 5596 type: integer 5597 usedMonthlyEvents: 5598 format: int64 5599 type: integer 5600 type: object 5601 Api.Core.Dto.Accounting.User: 5602 properties: 5603 boGoVal: 5604 type: string 5605 bonusClicks: 5606 format: int64 5607 type: integer 5608 companyName: 5609 type: string 5610 companyRole: 5611 type: string 5612 email: 5613 type: string 5614 firstName: 5615 type: string 5616 lastName: 5617 type: string 5618 phone: 5619 type: string 5620 redirectOnly: 5621 type: boolean 5622 registrationDate: 5623 description: ' (A date in "YmdHis" format)' 5624 example: '20120203120530' 5625 type: string 5626 timeframeMinDate: 5627 description: ' (A date in "YmdHis" format)' 5628 example: '20120203120530' 5629 type: string 5630 timezone: 5631 format: int32 5632 type: integer 5633 timezonename: 5634 type: string 5635 type: object 5636 Api.Core.Dto.Aggregated.AggregatedResult: 5637 properties: 5638 activityDay: 5639 description: ' (A date in "YmdHis" format)' 5640 example: '20120203120530' 5641 type: string 5642 commissionsCost: 5643 format: double 5644 type: number 5645 conversionsCost: 5646 format: double 5647 type: number 5648 conversionsValue: 5649 format: double 5650 type: number 5651 convertedClicks: 5652 format: int64 5653 type: integer 5654 entityData: 5655 $ref: '#/definitions/System.Object' 5656 entityId: 5657 type: string 5658 fromDay: 5659 description: ' (A date in "YmdHis" format)' 5660 example: '20120203120530' 5661 type: string 5662 hourlyBreakDown: 5663 additionalProperties: 5664 $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedResult' 5665 type: object 5666 lastHitDate: 5667 description: ' (A date in "YmdHis" format)' 5668 example: '20120203120530' 5669 type: string 5670 spiderHitsCount: 5671 format: int64 5672 type: integer 5673 toDay: 5674 description: ' (A date in "YmdHis" format)' 5675 example: '20120203120530' 5676 type: string 5677 totalClicks: 5678 format: int64 5679 type: integer 5680 totalViews: 5681 format: int64 5682 type: integer 5683 uniqueClicks: 5684 format: int64 5685 type: integer 5686 uniqueConversions: 5687 format: int64 5688 type: integer 5689 uniqueViews: 5690 format: int64 5691 type: integer 5692 type: object 5693 Api.Core.Dto.Aggregated.AggregatedSummaryResult: 5694 properties: 5695 count: 5696 format: int64 5697 type: integer 5698 limit: 5699 format: int32 5700 type: integer 5701 offset: 5702 format: int64 5703 type: integer 5704 result: 5705 items: 5706 $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedResult' 5707 type: array 5708 type: object 5709 Api.Core.Dto.ClickStream.Hit: 5710 properties: 5711 accessTime: 5712 description: ' (A date in "YmdHis" format)' 5713 example: '20120203120530' 5714 type: string 5715 browser: 5716 $ref: '#/definitions/Api.Core.Dto.ClickStream.HitBrowserInfo' 5717 clientLanguage: 5718 type: string 5719 conversion1: 5720 $ref: '#/definitions/Api.Core.Dto.ClickStream.HitConversionInfo' 5721 conversion2: 5722 $ref: '#/definitions/Api.Core.Dto.ClickStream.HitConversionInfo' 5723 conversion3: 5724 $ref: '#/definitions/Api.Core.Dto.ClickStream.HitConversionInfo' 5725 conversion4: 5726 $ref: '#/definitions/Api.Core.Dto.ClickStream.HitConversionInfo' 5727 conversion5: 5728 $ref: '#/definitions/Api.Core.Dto.ClickStream.HitConversionInfo' 5729 conversions: 5730 items: 5731 $ref: '#/definitions/Api.Core.Dto.ClickStream.HitConversionInfo' 5732 type: array 5733 entity: 5734 $ref: '#/definitions/Api.Core.Dto.ClickStream.HitDatapointInfo' 5735 ip: 5736 type: string 5737 isProxy: 5738 type: string 5739 isSpider: 5740 type: string 5741 isUnique: 5742 type: string 5743 location: 5744 $ref: '#/definitions/Api.Core.Dto.ClickStream.HitLocationInfo' 5745 org: 5746 type: string 5747 os: 5748 $ref: '#/definitions/Api.Core.Dto.ClickStream.HitOsInfo' 5749 queryParams: 5750 type: string 5751 realDestinationUrl: 5752 type: string 5753 referer: 5754 type: string 5755 source: 5756 $ref: '#/definitions/Api.Core.Dto.ClickStream.HitSource' 5757 type: 5758 type: string 5759 type: object 5760 Api.Core.Dto.ClickStream.HitBrowserInfo: 5761 properties: 5762 browserType: 5763 type: string 5764 familyId: 5765 format: int64 5766 type: integer 5767 familyName: 5768 type: string 5769 id: 5770 format: int64 5771 type: integer 5772 name: 5773 type: string 5774 type: object 5775 Api.Core.Dto.ClickStream.HitConversionInfo: 5776 properties: 5777 accessTime: 5778 description: ' (A date in "YmdHis" format)' 5779 example: '20120203120530' 5780 type: string 5781 comcost: 5782 format: double 5783 type: number 5784 cost: 5785 format: double 5786 type: number 5787 date: 5788 description: ' (A date in "YmdHis" format)' 5789 example: '20120203120530' 5790 type: string 5791 deleted: 5792 type: boolean 5793 id: 5794 format: int64 5795 type: integer 5796 name: 5797 type: string 5798 parameter: 5799 type: string 5800 value: 5801 format: double 5802 type: number 5803 type: object 5804 Api.Core.Dto.ClickStream.HitDatapointInfo: 5805 properties: 5806 creationDate: 5807 description: ' (A date in "YmdHis" format)' 5808 example: '20120203120530' 5809 type: string 5810 datapointFavourite: 5811 type: boolean 5812 datapointId: 5813 format: int64 5814 type: integer 5815 datapointName: 5816 type: string 5817 datapointTitle: 5818 type: string 5819 datapointType: 5820 type: string 5821 destinationUrl: 5822 type: string 5823 groupId: 5824 format: int64 5825 type: integer 5826 groupName: 5827 type: string 5828 isABTest: 5829 type: boolean 5830 isPrivateShared: 5831 type: boolean 5832 isPublic: 5833 type: boolean 5834 notes: 5835 type: string 5836 status: 5837 enum: 5838 - Active 5839 - Paused 5840 - Abuse 5841 - Deleted 5842 type: string 5843 tags: 5844 items: 5845 $ref: '#/definitions/Api.Core.Dto.Tags.Tag' 5846 type: array 5847 trackingCode: 5848 type: string 5849 type: object 5850 Api.Core.Dto.ClickStream.HitListPage: 5851 properties: 5852 hits: 5853 items: 5854 $ref: '#/definitions/Api.Core.Dto.ClickStream.Hit' 5855 type: array 5856 lastKey: 5857 type: string 5858 type: object 5859 Api.Core.Dto.ClickStream.HitLocationInfo: 5860 properties: 5861 areacode: 5862 type: string 5863 city: 5864 type: string 5865 country: 5866 type: string 5867 latitude: 5868 format: double 5869 type: number 5870 longitude: 5871 format: double 5872 type: number 5873 metrocode: 5874 type: string 5875 organization: 5876 type: string 5877 postalcode: 5878 type: string 5879 region: 5880 type: string 5881 regionName: 5882 type: string 5883 type: object 5884 Api.Core.Dto.ClickStream.HitOsInfo: 5885 properties: 5886 familyId: 5887 format: int64 5888 type: integer 5889 familyName: 5890 type: string 5891 id: 5892 format: int64 5893 type: integer 5894 name: 5895 type: string 5896 type: object 5897 Api.Core.Dto.ClickStream.HitSource: 5898 properties: 5899 id: 5900 format: int64 5901 type: integer 5902 name: 5903 type: string 5904 param: 5905 type: string 5906 type: object 5907 Api.Core.Dto.Conversions.Conversion: 5908 properties: 5909 code: 5910 type: string 5911 creationDate: 5912 description: ' (A date in "YmdHis" format)' 5913 example: '20120203120530' 5914 type: string 5915 deleted: 5916 type: boolean 5917 description: 5918 type: string 5919 id: 5920 format: int64 5921 type: integer 5922 name: 5923 type: string 5924 protocol: 5925 enum: 5926 - Http 5927 - Https 5928 type: string 5929 value: 5930 format: double 5931 type: number 5932 type: object 5933 Api.Core.Dto.Datapoints.BrowserBaseDestinationItem: 5934 properties: 5935 emailDestinationUrl: 5936 type: string 5937 mobileDestinationUrl: 5938 type: string 5939 spidersDestinationUrl: 5940 type: string 5941 type: object 5942 Api.Core.Dto.Datapoints.Datapoint: 5943 properties: 5944 creationDate: 5945 description: ' (A date in "YmdHis" format)' 5946 example: '20120203120530' 5947 type: string 5948 encodeIp: 5949 type: boolean 5950 fifthConversionId: 5951 format: int64 5952 type: integer 5953 fifthConversionName: 5954 type: string 5955 firstConversionId: 5956 format: int64 5957 type: integer 5958 firstConversionName: 5959 type: string 5960 fourthConversionId: 5961 format: int64 5962 type: integer 5963 fourthConversionName: 5964 type: string 5965 groupId: 5966 format: int64 5967 type: integer 5968 groupName: 5969 type: string 5970 id: 5971 format: int64 5972 type: integer 5973 isPublic: 5974 type: boolean 5975 isSecured: 5976 type: boolean 5977 lightTracking: 5978 type: boolean 5979 name: 5980 type: string 5981 notes: 5982 type: string 5983 preferred: 5984 type: boolean 5985 redirectOnly: 5986 type: boolean 5987 secondConversionId: 5988 format: int64 5989 type: integer 5990 secondConversionName: 5991 type: string 5992 status: 5993 enum: 5994 - Active 5995 - Paused 5996 - Abuse 5997 - Deleted 5998 type: string 5999 tags: 6000 items: 6001 $ref: '#/definitions/Api.Core.Dto.Tags.Tag' 6002 type: array 6003 thirdConversionId: 6004 format: int64 6005 type: integer 6006 thirdConversionName: 6007 type: string 6008 title: 6009 type: string 6010 trackingCode: 6011 type: string 6012 type: 6013 enum: 6014 - TrackingLink 6015 - TrackingPixel 6016 type: string 6017 typeTL: 6018 $ref: '#/definitions/Api.Core.Dto.Datapoints.TrackingLinkSpecifics' 6019 typeTP: 6020 $ref: '#/definitions/Api.Core.Dto.Datapoints.TrackingPixelSpecifics' 6021 writePermited: 6022 type: boolean 6023 type: object 6024 Api.Core.Dto.Datapoints.DatapointRetargetingInfo: 6025 properties: 6026 id: 6027 format: int64 6028 type: integer 6029 name: 6030 type: string 6031 type: object 6032 Api.Core.Dto.Datapoints.MultipleDestinationItem: 6033 properties: 6034 url: 6035 type: string 6036 type: object 6037 Api.Core.Dto.Datapoints.TrackingLinkSpecifics: 6038 properties: 6039 appendQuery: 6040 type: boolean 6041 browserDestinationItem: 6042 $ref: '#/definitions/Api.Core.Dto.Datapoints.BrowserBaseDestinationItem' 6043 destinationMode: 6044 enum: 6045 - Simple 6046 - RandomDestination 6047 - DestinationByLanguage 6048 - SpilloverDestination 6049 - DynamicUrl 6050 - BrowserDestination 6051 - DestinationByNation 6052 - UniqueDestination 6053 - SequentialDestination 6054 - WeightedDestination 6055 type: string 6056 domainId: 6057 format: int32 6058 type: integer 6059 encodeUrl: 6060 type: boolean 6061 expirationClicks: 6062 format: int64 6063 type: integer 6064 expirationDate: 6065 description: ' (A date in "YmdHis" format)' 6066 example: '20120203120530' 6067 type: string 6068 firstUrl: 6069 type: string 6070 goDomainId: 6071 format: int32 6072 type: integer 6073 hideUrl: 6074 type: boolean 6075 hideUrlTitle: 6076 type: string 6077 isABTest: 6078 type: boolean 6079 password: 6080 type: string 6081 pauseAfterClicksExpiration: 6082 type: boolean 6083 pauseAfterDateExpiration: 6084 type: boolean 6085 randomDestinationItems: 6086 items: 6087 $ref: '#/definitions/Api.Core.Dto.Datapoints.MultipleDestinationItem' 6088 type: array 6089 redirectType: 6090 enum: 6091 - PermanentRedirect 6092 - TemporaryRedirect 6093 type: string 6094 referrerClean: 6095 enum: 6096 - None 6097 - Clean 6098 - Myself 6099 type: string 6100 scripts: 6101 items: 6102 $ref: '#/definitions/Api.Core.Dto.Datapoints.DatapointRetargetingInfo' 6103 type: array 6104 sequentialDestinationItems: 6105 items: 6106 $ref: '#/definitions/Api.Core.Dto.Datapoints.MultipleDestinationItem' 6107 type: array 6108 spilloverDestinationItems: 6109 items: 6110 $ref: '#/definitions/Api.Core.Dto.Datapoints.MultipleDestinationItem' 6111 type: array 6112 uniqueDestinationItem: 6113 $ref: '#/definitions/Api.Core.Dto.Datapoints.UniqueDestinationItem' 6114 url: 6115 type: string 6116 urlAfterClicksExpiration: 6117 type: string 6118 urlAfterDateExpiration: 6119 type: string 6120 urlsByLanguage: 6121 items: 6122 $ref: '#/definitions/Api.Core.Dto.Datapoints.UrlByLanguageItem' 6123 type: array 6124 urlsByNation: 6125 items: 6126 $ref: '#/definitions/Api.Core.Dto.Datapoints.UrlByNationItem' 6127 type: array 6128 weightedDestinationItems: 6129 items: 6130 $ref: '#/definitions/Api.Core.Dto.Datapoints.WeightedDestinationItem' 6131 type: array 6132 type: object 6133 Api.Core.Dto.Datapoints.TrackingPixelSpecifics: 6134 properties: 6135 parameterNote: 6136 type: string 6137 type: object 6138 Api.Core.Dto.Datapoints.UniqueDestinationItem: 6139 properties: 6140 firstDestinationUrl: 6141 type: string 6142 type: object 6143 Api.Core.Dto.Datapoints.UrlByLanguageItem: 6144 properties: 6145 languageCode: 6146 type: string 6147 url: 6148 type: string 6149 type: object 6150 Api.Core.Dto.Datapoints.UrlByNationItem: 6151 properties: 6152 nation: 6153 type: string 6154 url: 6155 type: string 6156 type: object 6157 Api.Core.Dto.Datapoints.WeightedDestinationItem: 6158 properties: 6159 url: 6160 type: string 6161 weight: 6162 format: int32 6163 type: integer 6164 type: object 6165 Api.Core.Dto.Domains.Domain: 6166 properties: 6167 custom404: 6168 type: string 6169 customHomepage: 6170 type: string 6171 id: 6172 format: int64 6173 type: integer 6174 name: 6175 type: string 6176 type: 6177 enum: 6178 - System 6179 - Go 6180 - Dedicated 6181 - Personal 6182 type: string 6183 type: object 6184 Api.Core.Dto.EntityUriLong: 6185 properties: 6186 id: 6187 format: int64 6188 type: integer 6189 uri: 6190 type: string 6191 type: object 6192 Api.Core.Dto.Grants.Grant: 6193 properties: 6194 DatapointType: 6195 type: string 6196 Entity: 6197 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 6198 EntityName: 6199 type: string 6200 EntityType: 6201 type: string 6202 Type: 6203 type: string 6204 type: object 6205 Api.Core.Dto.Groups.Group: 6206 properties: 6207 creationDate: 6208 description: ' (A date in "YmdHis" format)' 6209 example: '20120203120530' 6210 type: string 6211 deleted: 6212 type: boolean 6213 id: 6214 format: int64 6215 type: integer 6216 isPublic: 6217 type: boolean 6218 name: 6219 type: string 6220 notes: 6221 type: string 6222 preferred: 6223 type: boolean 6224 redirectOnly: 6225 type: boolean 6226 tags: 6227 items: 6228 $ref: '#/definitions/Api.Core.Dto.Tags.Tag' 6229 type: array 6230 writePermited: 6231 type: boolean 6232 type: object 6233 Api.Core.Dto.Retargeting.RetargetingScript: 6234 properties: 6235 id: 6236 format: int64 6237 type: integer 6238 name: 6239 type: string 6240 script: 6241 type: string 6242 type: object 6243 Api.Core.Dto.Tags.Tag: 6244 properties: 6245 datapoints: 6246 items: 6247 format: int64 6248 type: integer 6249 type: array 6250 groups: 6251 items: 6252 format: int64 6253 type: integer 6254 type: array 6255 id: 6256 format: int64 6257 type: integer 6258 name: 6259 type: string 6260 type: object 6261 Api.Core.Dto.Tops.Top: 6262 properties: 6263 createdAt: 6264 description: ' (A date in "YmdHis" format)' 6265 example: '20120203120530' 6266 type: string 6267 data: 6268 items: 6269 $ref: '#/definitions/Api.Core.Dto.Tops.TopItem' 6270 type: array 6271 key: 6272 type: string 6273 type: object 6274 Api.Core.Dto.Tops.TopItem: 6275 properties: 6276 entityData: 6277 $ref: '#/definitions/System.Object' 6278 id: 6279 type: string 6280 lastHitDate: 6281 description: ' (A date in "YmdHis" format)' 6282 example: '20120203120530' 6283 type: string 6284 spiderClicks: 6285 format: int64 6286 type: integer 6287 spiderHits: 6288 format: int64 6289 type: integer 6290 spiderViews: 6291 format: int64 6292 type: integer 6293 totalClicks: 6294 format: int64 6295 type: integer 6296 totalCommissionsCost: 6297 format: double 6298 type: number 6299 totalConversions: 6300 format: int64 6301 type: integer 6302 totalConversionsCost: 6303 format: double 6304 type: number 6305 totalConversionsValue: 6306 format: double 6307 type: number 6308 totalHits: 6309 format: int64 6310 type: integer 6311 totalViews: 6312 format: int64 6313 type: integer 6314 uniqueClicks: 6315 format: int64 6316 type: integer 6317 uniqueHits: 6318 format: int64 6319 type: integer 6320 uniqueViews: 6321 format: int64 6322 type: integer 6323 type: object 6324 Api.Core.Requests.ConversionPatchBody: 6325 properties: 6326 Action: 6327 type: string 6328 Id: 6329 format: int64 6330 type: integer 6331 ReplaceId: 6332 format: int64 6333 type: integer 6334 type: object 6335 Api.Core.Requests.DatapointsBatch: 6336 properties: 6337 List: 6338 items: 6339 $ref: '#/definitions/Api.Core.Dto.Datapoints.Datapoint' 6340 type: array 6341 type: object 6342 Api.Core.Requests.DeleteBatch: 6343 properties: 6344 Entities: 6345 items: 6346 $ref: '#/definitions/Api.Core.Dto.EntityUriLong' 6347 type: array 6348 type: object 6349 Api.Core.Requests.GenericTextPatch: 6350 properties: 6351 Text: 6352 type: string 6353 type: object 6354 Api.Core.Requests.PatchBody: 6355 properties: 6356 Action: 6357 type: string 6358 Id: 6359 format: int64 6360 type: integer 6361 type: object 6362 Api.Core.Requests.PatchBodyBatch: 6363 properties: 6364 PatchRequests: 6365 items: 6366 $ref: '#/definitions/Api.Core.Requests.PatchBody' 6367 type: array 6368 type: object 6369 Api.Core.Requests.PermissionPatchRequest: 6370 properties: 6371 Action: 6372 type: string 6373 Id: 6374 format: int64 6375 type: integer 6376 Verb: 6377 type: string 6378 type: object 6379 Api.Core.Responses.CountResponce: 6380 properties: 6381 count: 6382 format: int64 6383 type: integer 6384 type: object 6385 'Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Accounting.DomainWhitelistEntry]': 6386 properties: 6387 entities: 6388 items: 6389 $ref: '#/definitions/Api.Core.Dto.Accounting.DomainWhitelistEntry' 6390 type: array 6391 type: object 6392 'Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Accounting.IpBlacklistEntry]': 6393 properties: 6394 entities: 6395 items: 6396 $ref: '#/definitions/Api.Core.Dto.Accounting.IpBlacklistEntry' 6397 type: array 6398 type: object 6399 'Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Aggregated.AggregatedResult]': 6400 properties: 6401 entities: 6402 items: 6403 $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedResult' 6404 type: array 6405 type: object 6406 'Api.Core.Responses.EntitiesResponse[Api.Core.Dto.ClickStream.Hit]': 6407 properties: 6408 entities: 6409 items: 6410 $ref: '#/definitions/Api.Core.Dto.ClickStream.Hit' 6411 type: array 6412 type: object 6413 'Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Grants.Grant]': 6414 properties: 6415 entities: 6416 items: 6417 $ref: '#/definitions/Api.Core.Dto.Grants.Grant' 6418 type: array 6419 type: object 6420 'Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]': 6421 properties: 6422 entities: 6423 items: 6424 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 6425 type: array 6426 type: object 6427 'Api.Core.Responses.EntityUri[System.Int64]': 6428 properties: 6429 id: 6430 format: int64 6431 type: integer 6432 uri: 6433 type: string 6434 type: object 6435 'Api.Core.Responses.ModifyBatchItemResponce[Api.Core.Dto.Datapoints.Datapoint,System.Int64]': 6436 properties: 6437 entityData: 6438 $ref: '#/definitions/Api.Core.Dto.Datapoints.Datapoint' 6439 errors: 6440 items: 6441 $ref: '#/definitions/ClickMeter.Infrastructure.Validation.ValidationFailure' 6442 type: array 6443 result: 6444 $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' 6445 status: 6446 type: string 6447 type: object 6448 ClickMeter.Infrastructure.Validation.ValidationFailure: 6449 properties: 6450 code: 6451 $ref: '#/definitions/System.Object' 6452 errorMessage: 6453 type: string 6454 errorValue: 6455 $ref: '#/definitions/System.Object' 6456 property: 6457 type: string 6458 type: object 6459 System.Object: 6460 properties: {} 6461 type: object