Sample Responses for Create Snapshot Requests

Response

Element	Description	Type
code	The response code can have following values: `success`, `failure`	string
details	Details of the error if value of response code is failure	string
snapshotId	ID of the snapshot	string
jobStatus	It is an indicator to confirm status of snapshot generation The possible values of jobStatus are: `pending`, `processing`, `done`, `failed`, `expired`	string

Sample Response 1

 { "code": "success", "snapshotId": "10", "details": "", "jobStatus": "pending" }

Sample Response 2

 { "code": "success", "snapshotId": "11", "details": "", "jobStatus": "pending" }

Sample Response 3

 { "code": "success", "snapshotId": "12", "details": "", "jobStatus": "pending" }

Sample Response 4

 { "code": "success", "snapshotId": "13", "details": "", "jobStatus": "pending" }

Sample Response 5

 { "code": "success", "snapshotId": "14", "details": "", "jobStatus": "pending" }

Sample Response 6

 { "code": "success", "snapshotId": "15", "details": "", "jobStatus": "pending"  }

Sample Response 7

 { "code": "success", "snapshotId": "16", "details": "", "jobStatus": "pending"  }

Sample Response 8

 { "code": "success", "snapshotId": "17", "details": "", "jobStatus": "pending" }

Sample Response 9

 { "code": "success", "snapshotId": "18", "details": "", "jobStatus": "pending" }

Sample Response 10

 { "code": "success", "snapshotId": "19", "details": "", "jobStatus": "pending" }

Sample Response 11

 { "code": "success", "snapshotId": "20", "details": "", "jobStatus": "pending"  }

Sample Response 12

 { "code": "failure", "snapshotId": "", "details": "outOfBudgetRecommendations Report does not support input params startDate, endDate or reportDate. /", "jobStatus": "" }

Sample Response 13

 { "code": "failure", "snapshotId": "",
  "details": "endDate, startDate, campaignId are mandatory metrics for outOfBudgetRecommendations report. ", "jobStatus": "" }

Sample Response 14

 { "code": "failure", "snapshotId": "", "details": "ReportMetrics Validation failed. Please provide valid reportMetrics values.", "jobStatus": "" }

Sample Response 15

 { "code": "failure", "snapshotId": "", "details": "itemId is not valid metric for keyword report.", "jobStatus": "" }

Sample Response 16

 { "code": "failure", "snapshotId": "", "details": "Metric name cannot be empty.", "jobStatus": "" }

Sample Response 17

 { "code": "failure", "snapshotId": "", "details": "wrongMetric metric is invalid.", "jobStatus": "" }