pinpoint-2016-12-01.examples.json 3.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. {
  2. "version": "1.0",
  3. "examples": {
  4. "GetJourneyRuns": [
  5. {
  6. "input": {
  7. "ApplicationId": "11111111112222222222333333333344",
  8. "JourneyId": "aaaaaaaaaabbbbbbbbbbccccccccccdd"
  9. },
  10. "output": {
  11. "JourneyRunsResponse": {
  12. "Item": [
  13. {
  14. "RunId": "99999999998888888888777777777766",
  15. "CreationTime": "2000-01-01T00:00:00.000Z",
  16. "LastUpdateTime": "2000-01-01T00:00:05.000Z",
  17. "Status": "COMPLETED"
  18. },
  19. {
  20. "RunId": "ffffffffffeeeeeeeeeeddddddddddcc",
  21. "CreationTime": "2000-01-01T00:00:10.000Z",
  22. "LastUpdateTime": "2000-01-01T00:00:10.000Z",
  23. "Status": "SCHEDULED"
  24. }
  25. ]
  26. }
  27. },
  28. "comments": {
  29. "input": {},
  30. "output": {}
  31. },
  32. "description": "The following example gets the runs of a journey.",
  33. "id": "to-get-the-runs-of-a-journey",
  34. "title": "To get the runs of a journey"
  35. }
  36. ],
  37. "GetJourneyRunExecutionMetrics": [
  38. {
  39. "input": {
  40. "ApplicationId": "11111111112222222222333333333344",
  41. "JourneyId": "aaaaaaaaaabbbbbbbbbbccccccccccdd",
  42. "RunId": "99999999998888888888777777777766"
  43. },
  44. "output": {
  45. "JourneyRunExecutionMetricsResponse": {
  46. "ApplicationId": "11111111112222222222333333333344",
  47. "JourneyId": "aaaaaaaaaabbbbbbbbbbccccccccccdd",
  48. "RunId": "99999999998888888888777777777766",
  49. "LastEvaluatedTime": "2000-01-01T00:00:05.000Z",
  50. "Metrics": {
  51. "ENDPOINT_PRODUCED": "1",
  52. "ENDPOINT_ENTERED": "1",
  53. "ENDPOINT_LEFT": "1"
  54. }
  55. }
  56. },
  57. "comments": {
  58. "input": {},
  59. "output": {}
  60. },
  61. "description": "The following example gets execution metrics for a single run of a journey.",
  62. "id": "to-get-the-execution-metrics-for-a-journey-run",
  63. "title": "To get the execution metrics for a journey run"
  64. }
  65. ],
  66. "GetJourneyRunExecutionActivityMetrics": [
  67. {
  68. "input": {
  69. "ApplicationId": "11111111112222222222333333333344",
  70. "JourneyId": "aaaaaaaaaabbbbbbbbbbccccccccccdd",
  71. "RunId": "99999999998888888888777777777766",
  72. "JourneyActivityId": "AAAAAAAAAA"
  73. },
  74. "output": {
  75. "JourneyRunExecutionActivityMetricsResponse": {
  76. "ApplicationId": "11111111112222222222333333333344",
  77. "JourneyId": "aaaaaaaaaabbbbbbbbbbccccccccccdd",
  78. "RunId": "99999999998888888888777777777766",
  79. "JourneyActivityId": "AAAAAAAAAA",
  80. "ActivityType": "EMAIL",
  81. "LastEvaluatedTime": "2000-01-01T00:00:05.000Z",
  82. "Metrics": {
  83. "SUCCESS": "1"
  84. }
  85. }
  86. },
  87. "comments": {
  88. "input": {},
  89. "output": {}
  90. },
  91. "description": "The following example gets activity execution metrics for a single run of a journey.",
  92. "id": "to-get-the-activity-execution-metrics-for-a-journey-run",
  93. "title": "To get the activity execution metrics for a journey run"
  94. }
  95. ]
  96. }
  97. }