Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

additional edits #449

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/data_warehouse.json
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,7 @@
"post" : {
"tags" : [ "Data Warehouse Scheduled Requests API" ],
"summary" : "Create a data warehouse scheduled request",
"description" : "Creates a new Schedule Data Warehouse request. An example definition for use in testing the API is shown below. This creates a request that generates a single report. To work properly, replace request.rsid with a report suite to which the user has access for Data Warehouse, and then add a valid export Location UUID under delivery.\n\n```json\n{\r\n \"schedule\": {\r\n \"periodSettings\": {\r\n \"frequency\": \"runOnceSetPeriod\"\r\n }\r\n },\r\n \"request\": {\r\n \"name\": \"Run-Once Example\",\r\n \"reportParameters\": {\r\n \"reportRange\": {\r\n \"startDateTime\": \"2023-01-01T00:00:00Z\",\r\n \"endDateTime\": \"2023-01-01T23:59:59Z\"\r\n },\r\n \"dimensionList\": [\r\n ],\r\n \"metricList\": [\r\n {\r\n \"id\": \"metrics/visitors\"\r\n }\r\n ]\r\n },\r\n \"rsid\": \"sistr2\"\r\n },\r\n \"delivery\": {\r\n \"exportLocationUUID\": \"00000000-0000-0000-0000-000000000000\",\r\n \"email\": {\r\n \"notificationEmailTo\": \"donotuse@adobe.com\"\r\n }\r\n }\r\n}\r\n```\n\n Below is an example of how you could make the same request, but have it generate a daily report (for yesterday's data) for 10 days.\n\n```json\n{\r\n \"schedule\": {\r\n \"periodSettings\": {\r\n \"frequency\": \"daily\"\r\n }, \"cancelSettings\": {\r\n \"cancelMethod\": \"afterOccurrences\",\r\n \"endAfterNumOccurrences\": 10\r\n }\r\n },\r\n \"request\": {\r\n \"name\": \"Run Daily Example\",\r\n \"reportParameters\": {\r\n \"reportRange\": {\r\n \"preset\": \"Yesterday\"\r\n },\r\n \"dimensionList\": [\r\n ],\r\n \"metricList\": [\r\n {\r\n \"id\": \"metrics/visitors\"\r\n }\r\n ]\r\n },\r\n \"rsid\": \"sistr2\"\r\n },\r\n \"delivery\": {\r\n \"exportLocationUUID\": \"00000000-0000-0000-0000-000000000000\",\r\n \"email\": {\r\n \"notificationEmailTo\": \"donotuse@adobe.com\"\r\n }\r\n }\r\n}\r\n```\n\nThe 'id' of items in the metricList are identity service names. Below is an example of what an entry in metricsList would look like to use the participation metric instead.\n\n```json\n{\r\n \"id\": \"metrics/campaigninstances\",\r\n \"properties\": {\r\n \"isParticipation\": true\r\n }\r\n}\r\n\r\n```\n\nFor dimensionList the entries can be from identity service or segment service and the 'id' should be the 'id' of the value in either service. This is an example of a what an entry in dimenionList that uses an identity would look like.\n\n```json\n{\r\n \"id\": \"variables/geocity\",\r\n}\r\n\r\n```\n\nThis is an example of a what an entry in dimenionList that uses an segment would look like.\n\n```json\n{\r\n \"namespace\": \"Segment Service\",\r\n \"id\": \"s0_000000000000000000000000\",\r\n}\r\n\r\n```\n\n",
"description" : "Creates a new scheduled Data Warehouse request. An example definition for testing the API is shown below. This creates a request that generates a single report. To use the example, specify a "request.rsid" to which you have Data Warehouse access (shown in the example as "sistr2"), and then add a valid "exportLocationUUID."
"operationId" : "createDataWarehouseScheduledJob",
"parameters" : [],
"requestBody" : {
Expand Down
Loading