{ "opencollection": "1.0.0", "info": { "name": "Kickstart API", "version": "1.0" }, "items": [ { "info": { "name": "whitelabel-domain-controller", "type": "folder" }, "items": [ { "info": { "name": "get", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/whitelabel_domains/:orgId", "params": [ { "name": "orgId", "value": "", "type": "path" } ] } }, { "info": { "name": "update", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/whitelabel_domains/:orgId", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "acctId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/whitelabel_domains/:orgId", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "acctId", "value": "", "type": "query" } ] } }, { "info": { "name": "getWhitelabelDomains", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/whitelabel_domains" } }, { "info": { "name": "create", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/whitelabel_domains", "params": [ { "name": "acctId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "getByDomainName", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/whitelabel_domains/get_by_domain_name", "params": [ { "name": "domainName", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "user-controller", "type": "folder" }, "items": [ { "info": { "name": "mapAdvertisers", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/users/:userId/mapAdvertisers", "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "mapAccounts", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/users/:userId/mapAccounts", "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "get_1", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/users/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "update_1", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/users/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "delete_1", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/users/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "getAll", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/users", "params": [ { "name": "accountId", "value": "", "type": "query" } ] } }, { "info": { "name": "create_1", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/users", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "createPasswordResetUrl", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/users/:userId/password_reset/url", "params": [ { "name": "userId", "value": "", "type": "path" } ] } }, { "info": { "name": "inviteUser", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/users/:userId/invite", "params": [ { "name": "userId", "value": "", "type": "path" } ] } }, { "info": { "name": "inviteUserUrl", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/users/:userId/invite/url", "params": [ { "name": "userId", "value": "", "type": "path" } ] } }, { "info": { "name": "updateUserRoles", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/users/:userId/globalRoles/:roleId", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "roleId", "value": "", "type": "path" }, { "name": "userRole", "value": "", "type": "query" } ] } }, { "info": { "name": "deleteUserRoles", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/users/:userId/globalRoles/:roleId", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "roleId", "value": "", "type": "path" }, { "name": "userRole", "value": "", "type": "query" } ] } }, { "info": { "name": "activateSolution", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/users/:userId/activateSolution", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "accountName", "value": "", "type": "query" }, { "name": "advertiserName", "value": "", "type": "query" }, { "name": "solutionName", "value": "", "type": "query" } ] } }, { "info": { "name": "findUserGlobalRoles", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/users/:userId/globalRoles", "params": [ { "name": "userId", "value": "", "type": "path" } ] } }, { "info": { "name": "getUserByOrgId", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/users/organization", "params": [ { "name": "orgId", "value": "", "type": "query" } ] } }, { "info": { "name": "getUsersByAdvertiserId", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/users/advertiser", "params": [ { "name": "advertiserId", "value": "", "type": "query" } ] } }, { "info": { "name": "removeAdvertiser", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/users/:userId/removeAdvertiser", "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "removeAccount", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/users/:userId/removeAccount", "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } } ] }, { "info": { "name": "segment-controller", "type": "folder" }, "items": [ { "info": { "name": "getSegmentById", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/segments/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "updateSegment", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/segments/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "deleteSegment", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/segments/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "getAllSegments", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/segments" } }, { "info": { "name": "createSegment", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/segments", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "downloadRecordsAsJson", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/segments/download" } } ] }, { "info": { "name": "rate-cards-controller", "type": "folder" }, "items": [ { "info": { "name": "updateRateCard", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/rateCards/:productTypeId", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "createRateCardItem", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/rateCards", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "listRateCards", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/rateCards/:accountId", "params": [ { "name": "accountId", "value": "", "type": "path" }, { "name": "accountType", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "publisher-deal-mapping-controller", "type": "folder" }, "items": [ { "info": { "name": "get_2", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/publisherDeal/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "update_2", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/publisherDeal/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "delete_2", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/publisherDeal/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "list", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/publisherDeal" } }, { "info": { "name": "create_2", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/publisherDeal", "body": { "type": "json", "data": "{}" } } } ] }, { "info": { "name": "plans-controller", "type": "folder" }, "items": [ { "info": { "name": "get_3", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/plans/:planId", "params": [ { "name": "planId", "value": "", "type": "path" }, { "name": "includePacing", "value": "", "type": "query" }, { "name": "advertiser", "value": "", "type": "query" }, { "name": "client", "value": "", "type": "query" }, { "name": "xandrId", "value": "", "type": "query" }, { "name": "pixel", "value": "", "type": "query" } ] } }, { "info": { "name": "updatePlan", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/plans/:planId", "params": [ { "name": "planId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "delete_3", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/plans/:planId", "params": [ { "name": "planId", "value": "", "type": "path" } ] } }, { "info": { "name": "updateFlag", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/plans/:planId/updateFlag", "params": [ { "name": "planId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "changeTargetingLevel", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/plans/:planId/changeTargetingLevel", "params": [ { "name": "planId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "changeProductTypeAllocation", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/plans/:planId/changeProductTypeAllocation", "params": [ { "name": "planId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "changeProductCategoryAllocation", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/plans/:planId/changeProductCategoryAllocation", "params": [ { "name": "planId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "changeDisplayDeviceAllocation", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/plans/:planId/changeDisplayDeviceAllocation", "params": [ { "name": "planId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "getAll_1", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/plans", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" }, { "name": "crFilter", "value": "", "type": "query" }, { "name": "flip", "value": "", "type": "query" }, { "name": "includePacing", "value": "", "type": "query" }, { "name": "advertiser", "value": "", "type": "query" }, { "name": "client", "value": "", "type": "query" }, { "name": "xandrId", "value": "", "type": "query" }, { "name": "pixel", "value": "", "type": "query" } ] } }, { "info": { "name": "create_3", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/plans", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "workflowEmailNotification", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/plans/:planId/workflowEmailNotification", "params": [ { "name": "planId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "updateStatusEmailNotification", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/plans/:planId/updateStatusEmailNotification", "params": [ { "name": "planId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "sendSubmitOrderNotification", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/plans/:planId/sendSubmitOrderNotification", "params": [ { "name": "planId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "emailNotification", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/plans/:planId/sendEmailNotification", "params": [ { "name": "planId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "exportOrder", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/plans/:planId/export", "params": [ { "name": "planId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "createOrder", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/plans/:planId/createOrder", "params": [ { "name": "planId", "value": "", "type": "path" } ] } }, { "info": { "name": "changeAppliedEmailNotification", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/plans/:planId/changeAppliedEmailNotification", "params": [ { "name": "planId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } } ] }, { "info": { "name": "organization-controller", "type": "folder" }, "items": [ { "info": { "name": "getOrganization", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/organizations/:organizationId", "params": [ { "name": "organizationId", "value": "", "type": "path" } ] } }, { "info": { "name": "update_3", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/organizations/:organizationId", "params": [ { "name": "organizationId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "getOrganizations", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/organizations" } }, { "info": { "name": "create_5", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/organizations", "body": { "type": "json", "data": "{}" } } } ] }, { "info": { "name": "publisher-media-type-mapping-controller", "type": "folder" }, "items": [ { "info": { "name": "get_4", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/mediaTypes/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "update_4", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/mediaTypes/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "delete_4", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/mediaTypes/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "list_1", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/mediaTypes" } }, { "info": { "name": "create_6", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/mediaTypes", "body": { "type": "json", "data": "{}" } } } ] }, { "info": { "name": "media-publisher-master-controller", "type": "folder" }, "items": [ { "info": { "name": "get_5", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/mediaPublisher/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "update_5", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/mediaPublisher/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "delete_5", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/mediaPublisher/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "list_2", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/mediaPublisher" } }, { "info": { "name": "create_7", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/mediaPublisher", "body": { "type": "json", "data": "{}" } } } ] }, { "info": { "name": "line-items-controller", "type": "folder" }, "items": [ { "info": { "name": "update_6", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/ios/:insertionOrderId/lineItems/:lineItemId", "params": [ { "name": "insertionOrderId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "delete_6", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/ios/:insertionOrderId/lineItems/:lineItemId", "params": [ { "name": "insertionOrderId", "value": "", "type": "path" }, { "name": "lineItemId", "value": "", "type": "path" } ] } }, { "info": { "name": "updateFlag_1", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/ios/:insertionOrderId/lineItems/:lineItemId/updateFlag", "params": [ { "name": "insertionOrderId", "value": "", "type": "path" }, { "name": "lineItemId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "pushToXandr", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/ios/:insertionOrderId/lineItems/:lineItemId/pushToXandr", "params": [ { "name": "insertionOrderId", "value": "", "type": "path" }, { "name": "lineItemId", "value": "", "type": "path" } ] } }, { "info": { "name": "emailNotification_1", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/ios/:lineItemId/sendEmailNotification", "params": [ { "name": "lineItemId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "customEmailNotification", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/ios/:lineItemId/customEmailNotification", "params": [ { "name": "lineItemId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "sendResubmitEmailNotification", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/ios/:insertionOrderId/:lineItemId/sendResubmitEmailNotification", "params": [ { "name": "insertionOrderId", "value": "", "type": "path" }, { "name": "lineItemId", "value": "", "type": "path" } ] } }, { "info": { "name": "index", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ios/:insertionOrderId/lineItems", "params": [ { "name": "insertionOrderId", "value": "", "type": "path" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "create_8", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/ios/:insertionOrderId/lineItems", "params": [ { "name": "insertionOrderId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "calculatePriceSpend", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/ios/:insertionOrderId/lineItems/:lineItemId/calculatePriceSpend", "params": [ { "name": "insertionOrderId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "calculateCpm", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/ios/:insertionOrderId/lineItems/:lineItemId/calculateCpm", "params": [ { "name": "insertionOrderId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "lineItemNamesDataFromBQ", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ios/:advertiserId/msdp/lineItemNamesData", "params": [ { "name": "advertiserId", "value": "", "type": "path" }, { "name": "planIds", "value": "", "type": "query" } ] } }, { "info": { "name": "lineItemNamesData", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ios/:advertiserId/lineItemNamesData", "params": [ { "name": "advertiserId", "value": "", "type": "path" }, { "name": "planIds", "value": "", "type": "query" }, { "name": "ioNames", "value": "", "type": "query" }, { "name": "includeNonFlip", "value": "", "type": "query" } ] } }, { "info": { "name": "workflowStatusCount", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ios/workflowStatusCount", "params": [ { "name": "accountId", "value": "", "type": "query" } ] } }, { "info": { "name": "workflowStatsCount", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ios/plan/workflowStatsCount", "params": [ { "name": "accountId", "value": "", "type": "query" } ] } }, { "info": { "name": "lineItemStatusCount", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ios/plan/lineItemStatusCount", "params": [ { "name": "accountId", "value": "", "type": "query" }, { "name": "advertiserId", "value": "", "type": "query" }, { "name": "isFlip", "value": "", "type": "query" } ] } }, { "info": { "name": "lineItemStatusCountForPlans", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ios/plan/lineItemStatusCountForPlans", "params": [ { "name": "accountId", "value": "", "type": "query" }, { "name": "advertiserId", "value": "", "type": "query" }, { "name": "isFlip", "value": "", "type": "query" } ] } }, { "info": { "name": "getAll_7", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ios/lineItems", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" }, { "name": "crFilter", "value": "", "type": "query" } ] } }, { "info": { "name": "getLineItem", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ios/lineItem/:lineItemId", "params": [ { "name": "lineItemId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "comment-controller", "type": "folder" }, "items": [ { "info": { "name": "get_6", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/comments/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "update_7", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/comments/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "delete_7", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/comments/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "list_3", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/comments", "params": [ { "name": "itemId", "value": "", "type": "query" }, { "name": "itemType", "value": "", "type": "query" } ] } }, { "info": { "name": "create_9", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/comments", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "notification", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/comments/notification", "body": { "type": "json", "data": "{}" } } } ] }, { "info": { "name": "budget-group-controller", "type": "folder" }, "items": [ { "info": { "name": "update_8", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/budgetGroup/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "create_10", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/budgetGroup/create", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "getByPlanId", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/budgetGroup/budgetGroupByPlanId/:ioId", "params": [ { "name": "ioId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "agency-controller", "type": "folder" }, "items": [ { "info": { "name": "mapAdvertiser", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/agencies/:agencyId/mapAdvertiser", "params": [ { "name": "agencyId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "getAll_3", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/agencies", "params": [ { "name": "accountId", "value": "", "type": "query" } ] } }, { "info": { "name": "create_11", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/agencies", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "getAgency", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/agencies/:agencyId", "params": [ { "name": "agencyId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "advertiser-controller", "type": "folder" }, "items": [ { "info": { "name": "getAdvertiser", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId", "params": [ { "name": "advertiserId", "value": "", "type": "path" } ] } }, { "info": { "name": "update_9", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId", "params": [ { "name": "advertiserId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "mapUsers", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/mapUsers", "params": [ { "name": "advertiserId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "getByAccount", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers", "params": [ { "name": "accountId", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query" }, { "name": "userId", "value": "", "type": "query" } ] } }, { "info": { "name": "create_12", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "sendPixelReadyEmailNotification", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/pixelReadyEmailNotification", "params": [ { "name": "advertiserId", "value": "", "type": "path" } ] } }, { "info": { "name": "sendAdvertiserUpdateEmailNotification", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/advertiserUpdateEmailNotification", "params": [ { "name": "advertiserId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "createAll", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/ah/create_all", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "get", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/:id/audienceNames", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "get" }, { "info": { "name": "getCrossViewDspIdsByAdvertiserId", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/crossview/dsp", "params": [ { "name": "advertiserId", "value": "", "type": "path" } ] } }, { "info": { "name": "getDspIdByUniversalPixelId", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/dsp/:pixelId", "params": [ { "name": "pixelId", "value": "", "type": "path" } ] } }, { "info": { "name": "getAdvertiserMapping", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/advertiserMapping", "params": [ { "name": "advertiserIdType", "value": "", "type": "query" }, { "name": "advertiserId", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "Flip Dashboard", "type": "folder" }, "items": [ { "info": { "name": "Get details of a FLIP pixel for an advertiser", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/flipPixels/:pixelId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser ID" }, { "name": "pixelId", "value": "", "type": "path", "description": "The FLIP pixel ID" } ] }, "docs": "Returns metadata for a given FLIP pixel and advertiser" }, { "info": { "name": "Update an existing FLIP pixel for an advertiser", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/flipPixels/:pixelId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser ID" }, { "name": "pixelId", "value": "", "type": "path", "description": "The pixel ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a FLIP pixel's properties using the provided data" }, { "info": { "name": "Update campaign", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/brand_lift/campaigns/:blCampaignId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "blCampaignId", "value": "", "type": "path", "description": "Campaign Id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update campaign" }, { "info": { "name": "Delete campaign", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/brand_lift/campaigns/:blCampaignId", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "blCampaignId", "value": "", "type": "path", "description": "Campaign Id" } ] }, "docs": "Delete campaign" }, { "info": { "name": "Launch Campaign", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/brand_lift/campaigns/:blCampaignId/launch", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "blCampaignId", "value": "", "type": "path", "description": "Campaign Id" } ] }, "docs": "Launch Campaign" }, { "info": { "name": "Update SPC Groupings and Mappings", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/brand_lift/campaign/:blCampaignId/spc_groupings_and_mappings", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "blCampaignId", "value": "", "type": "path", "description": "Brandlift campaign id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "type", "value": "", "type": "query", "description": "SPC Grouping types: placement or publisher" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update SPC Groupings and Mappings" }, { "info": { "name": "Get rollup report with only last touches for each conversion", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/reports/rollup", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "kind", "value": "", "type": "query", "description": "the kind of data to be returned, either all_touch or last_touch" }, { "name": "includeChannel", "value": "", "type": "query", "description": "true : Include channel false : Dont include channel" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "xandrId", "value": "", "type": "query", "description": "the advertiser's XandrId" }, { "name": "pixel", "value": "", "type": "query", "description": "the FLIP universal pixel id" }, { "name": "conversionWindow", "value": "", "type": "query", "description": "the conversion window in hours" }, { "name": "mediaType", "value": "", "type": "query", "description": "the media types to filter (e.g. Display Retargeting, OTT, etc.)" }, { "name": "creative", "value": "", "type": "query", "description": "the comma-separated creative ids to filter" }, { "name": "publisher", "value": "", "type": "query", "description": "the comma-separated publisher names to filter" }, { "name": "audience", "value": "", "type": "query", "description": "the comma-separated audience names to filter" }, { "name": "ioIds", "value": "", "type": "query", "description": "the comma-separated IO ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated Adready Id & start date (separated by |) combination to filter" }, { "name": "event", "value": "", "type": "query", "description": "the event" }, { "name": "category", "value": "", "type": "query", "description": "the pixel category" }, { "name": "subCategory", "value": "", "type": "query", "description": "the comma-separated pixel sub-categories" }, { "name": "startDate", "value": "", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "", "type": "query", "description": "the end date" }, { "name": "offset", "value": "", "type": "query", "description": "the number of records to skip" }, { "name": "limit", "value": "", "type": "query", "description": "the max number of records to return" }, { "name": "onceNow", "value": "", "type": "query", "description": "Run this report once?" }, { "name": "emailIt", "value": "", "type": "query", "description": "Email this report?" }, { "name": "emailAddr", "value": "", "type": "query", "description": "Email address?" } ] }, "docs": "Get rollup report with only last touches for each conversion" }, { "info": { "name": "Get all touches (except last touch) for a conversion", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/reports/rollup/touches", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "xandrId", "value": "", "type": "query", "description": "the advertiser's XandrId" }, { "name": "pixel", "value": "", "type": "query", "description": "the FLIP universal pixel id" }, { "name": "conversionWindow", "value": "", "type": "query", "description": "the conversion window in hours" }, { "name": "mediaType", "value": "", "type": "query", "description": "the media types to filter (e.g. Display Retargeting, OTT, etc.)" }, { "name": "creative", "value": "", "type": "query", "description": "the comma-separated creative ids to filter" }, { "name": "publisher", "value": "", "type": "query", "description": "the comma-separated publisher names to filter" }, { "name": "audience", "value": "", "type": "query", "description": "the comma-separated audience names to filter" }, { "name": "ioIds", "value": "", "type": "query", "description": "the comma-separated IO ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated Adready Id & start date (separated by |) combination to filter" }, { "name": "event", "value": "", "type": "query", "description": "the event" }, { "name": "category", "value": "", "type": "query", "description": "the pixel category" }, { "name": "subCategory", "value": "", "type": "query", "description": "the comma-separated pixel sub-categories" }, { "name": "startDate", "value": "", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "", "type": "query", "description": "the end date" }, { "name": "ip", "value": "", "type": "query", "description": "the IP address" }, { "name": "ts", "value": "", "type": "query", "description": "the pixel timestamp in micro seconds" } ] }, "docs": "Get all touches (except last touch) for a conversion" }, { "info": { "name": "Get performance report by creative/publisher/channel/daypart/audience/device/mediatype/state/dma/zip/overall", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/reports/performance", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "kind", "value": "", "type": "query", "description": "the field by which data to be grouped, either creative/adgroup/publisher/channel/daypart/audience/device/mediatype/state/dma/zip/overall" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "xandrId", "value": "", "type": "query", "description": "the advertiser's XandrId" }, { "name": "pixel", "value": "", "type": "query", "description": "the FLIP universal pixel id" }, { "name": "showUniques", "value": "", "type": "query", "description": "flag to decide whether to show only uniques or not" }, { "name": "conversionWindow", "value": "", "type": "query", "description": "the conversion window in hours" }, { "name": "mediaType", "value": "", "type": "query", "description": "the media types to filter (e.g. Display Retargeting, OTT, etc.)" }, { "name": "creative", "value": "", "type": "query", "description": "the comma-separated creative ids to filter" }, { "name": "publisher", "value": "", "type": "query", "description": "the comma-separated publisher names to filter" }, { "name": "audience", "value": "", "type": "query", "description": "the comma-separated audience names to filter" }, { "name": "ioIds", "value": "", "type": "query", "description": "the comma-separated IO ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated Adready Id & start date (separated by |) combination to filter" }, { "name": "attribution", "value": "", "type": "query", "description": "the conversion attribution to be used, either full or partial" }, { "name": "methodology", "value": "", "type": "query", "description": "the methodology to be used, either first_touch/last_touch/linear/time_decay" }, { "name": "event", "value": "", "type": "query", "description": "the event" }, { "name": "category", "value": "", "type": "query", "description": "the pixel category" }, { "name": "subCategory", "value": "", "type": "query", "description": "the comma-separated pixel sub-categories" }, { "name": "startDate", "value": "", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "", "type": "query", "description": "the end date" }, { "name": "fields", "value": "", "type": "query", "description": "the comma-separated fields to return" }, { "name": "offset", "value": "", "type": "query", "description": "the number of records to skip" }, { "name": "limit", "value": "", "type": "query", "description": "the max number of records to return" }, { "name": "onceNow", "value": "", "type": "query", "description": "Run this report once?" }, { "name": "emailIt", "value": "", "type": "query", "description": "Email this report?" }, { "name": "emailAddr", "value": "", "type": "query", "description": "Email address?" } ] }, "docs": "Get performance report by creative/publisher/channel/daypart/audience/device/mediatype/state/dma/zip/overall" }, { "info": { "name": "Get event-wise performance report by creative/publisher/channel/daypart/audience/device/mediatype/state/dma/zip/overall", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/reports/eventPerformance", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "kind", "value": "", "type": "query", "description": "the field by which data to be grouped, either creative/adgroup/publisher/channel/daypart/audience/device/mediatype/state/dma/zip/overall" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "xandrId", "value": "", "type": "query", "description": "the advertiser's XandrId" }, { "name": "pixel", "value": "", "type": "query", "description": "the FLIP universal pixel id" }, { "name": "showUniques", "value": "", "type": "query", "description": "flag to decide whether to show only uniques or not" }, { "name": "conversionWindow", "value": "", "type": "query", "description": "the conversion window in hours" }, { "name": "mediaType", "value": "", "type": "query", "description": "the media types to filter (e.g. Display Retargeting, OTT, etc.)" }, { "name": "creative", "value": "", "type": "query", "description": "the comma-separated creative ids to filter" }, { "name": "publisher", "value": "", "type": "query", "description": "the comma-separated publisher names to filter" }, { "name": "audience", "value": "", "type": "query", "description": "the comma-separated audience names to filter" }, { "name": "ioIds", "value": "", "type": "query", "description": "the comma-separated IO ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated Adready Id & start date (separated by |) combination to filter" }, { "name": "attribution", "value": "", "type": "query", "description": "the conversion attribution to be used, either full or partial" }, { "name": "methodology", "value": "", "type": "query", "description": "the methodology to be used, either first_touch/last_touch/linear/time_decay" }, { "name": "event", "value": "", "type": "query", "description": "the event" }, { "name": "category", "value": "", "type": "query", "description": "the pixel category" }, { "name": "subCategory", "value": "", "type": "query", "description": "the comma-separated pixel sub-categories" }, { "name": "startDate", "value": "", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "", "type": "query", "description": "the end date" }, { "name": "fields", "value": "", "type": "query", "description": "the comma-separated fields to return" }, { "name": "offset", "value": "", "type": "query", "description": "the number of records to skip" }, { "name": "limit", "value": "", "type": "query", "description": "the max number of records to return" }, { "name": "onceNow", "value": "", "type": "query", "description": "Run this report once?" }, { "name": "emailIt", "value": "", "type": "query", "description": "Email this report?" }, { "name": "emailAddr", "value": "", "type": "query", "description": "Email address?" } ] }, "docs": "Get event-wise performance report by creative/publisher/channel/daypart/audience/device/mediatype/state/dma/zip/overall" }, { "info": { "name": "Get performance by creative/adgroup/publisher/channel/audience/mediatype", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/performance", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser ID" }, { "name": "groupBy", "value": "", "type": "query", "description": "The field to group by" }, { "name": "client", "value": "", "type": "query", "description": "The client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "The advertiser name" }, { "name": "xandrId", "value": "", "type": "query", "description": "The advertiser's Xandr ID" }, { "name": "pixel", "value": "", "type": "query", "description": "The FLIP universal pixel ID" }, { "name": "showUniques", "value": "", "type": "query", "description": "Whether to show only uniques" }, { "name": "conversionWindow", "value": "", "type": "query", "description": "Conversion window in hours" }, { "name": "mediaType", "value": "", "type": "query", "description": "Media types to filter" }, { "name": "startDate", "value": "", "type": "query", "description": "The start date" }, { "name": "endDate", "value": "", "type": "query", "description": "The end date" } ] }, "docs": "Returns grouped performance metrics" }, { "info": { "name": "Get reach and frequency performance metric", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/performance/metrics/reach", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser ID" }, { "name": "client", "value": "", "type": "query", "description": "The account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "The advertiser name" }, { "name": "xandrId", "value": "", "type": "query", "description": "The advertiser's XandrId" }, { "name": "mediaType", "value": "", "type": "query", "description": "Media types to filter (e.g., Display Retargeting, OTT, etc.)" }, { "name": "creative", "value": "", "type": "query", "description": "Comma-separated creative IDs to filter" }, { "name": "publisher", "value": "", "type": "query", "description": "Comma-separated publisher names to filter" }, { "name": "audience", "value": "", "type": "query", "description": "Comma-separated audience names to filter" }, { "name": "ioIds", "value": "", "type": "query", "description": "Comma-separated IO IDs to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "Comma-separated AdReady ID & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "", "type": "query", "description": "Start date" }, { "name": "endDate", "value": "", "type": "query", "description": "End date" }, { "name": "compareStartDate", "value": "", "type": "query", "description": "Compare start date" }, { "name": "compareEndDate", "value": "", "type": "query", "description": "Compare end date" } ] }, "docs": "Returns reach and frequency metrics for a given advertiser and filters" }, { "info": { "name": "Get daily CPM/CPA/ROAS/VCR/CTR performance", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/performance/daily", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "kind", "value": "", "type": "query", "description": "the kind of data to be returned, either CPM or CPA or ROAS or VCR or CTR" } ] }, "docs": "Retrieve daily metrics such as CPM, CPA, ROAS, VCR, and CTR." }, { "info": { "name": "Get daily CPM/CPA/ROAS/VCR/CTR performance", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/mdsp/performance/daily", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "kind", "value": "", "type": "query", "description": "the kind of data to be returned, either CPM or CPA or ROAS or VCR or CTR" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "xandrId", "value": "", "type": "query", "description": "the advertiser's XandrId" }, { "name": "pixel", "value": "", "type": "query", "description": "the FLIP universal pixel id" }, { "name": "showUniques", "value": "", "type": "query", "description": "flag to decide whether to show only uniques or not" }, { "name": "conversionWindow", "value": "", "type": "query", "description": "the conversion window in hours" }, { "name": "mediaType", "value": "", "type": "query", "description": "the media types to filter (e.g. Display Retargeting, OTT, etc.)" }, { "name": "creative", "value": "", "type": "query", "description": "the comma-separated creative ids to filter" }, { "name": "publisher", "value": "", "type": "query", "description": "the comma-separated publisher names to filter" }, { "name": "audience", "value": "", "type": "query", "description": "the comma-separated audience names to filter" }, { "name": "ioIds", "value": "", "type": "query", "description": "the comma-separated IO ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated Adready Id & start date (separated by |) combination to filter" }, { "name": "attribution", "value": "", "type": "query", "description": "the conversion attribution to be used, either full or partial" }, { "name": "methodology", "value": "", "type": "query", "description": "the methodology to be used, either first_touch/last_touch/linear/time_decay" }, { "name": "event", "value": "", "type": "query", "description": "the event" }, { "name": "category", "value": "", "type": "query", "description": "the pixel category" }, { "name": "subCategory", "value": "", "type": "query", "description": "the comma-separated pixel sub-categories" }, { "name": "startDate", "value": "2022-01-08", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "2022-01-14", "type": "query", "description": "the end date" }, { "name": "compareStartDate", "value": "2022-01-01", "type": "query", "description": "the compare start date" }, { "name": "compareEndDate", "value": "2022-01-07", "type": "query", "description": "the compare end date" }, { "name": "cumulative", "value": "", "type": "query", "description": "flag to specify cumulative or not." } ] }, "docs": "Retrieve daily performance metrics like CPM, CPA, ROAS, VCR, CTR" }, { "info": { "name": "Get impressions summary (MDSP)", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/mdsp/impressions/summary", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser id" }, { "name": "kind", "value": "", "type": "query", "description": "Return what data? Choices: Impressions / Ad Spend / Video Completions / Clicks" }, { "name": "client", "value": "", "type": "query", "description": "The account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "The advertiser name" }, { "name": "xandrId", "value": "", "type": "query", "description": "The advertiser's XandrId" }, { "name": "mediaType", "value": "", "type": "query", "description": "The media types to filter (e.g. Display Retargeting, OTT, etc.)" }, { "name": "creative", "value": "", "type": "query", "description": "The comma-separated creative ids to filter" }, { "name": "publisher", "value": "", "type": "query", "description": "The comma-separated publisher names to filter" }, { "name": "audience", "value": "", "type": "query", "description": "The comma-separated audience names to filter" }, { "name": "ioIds", "value": "", "type": "query", "description": "The comma-separated IO ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "The comma-separated Adready Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "2022-01-08", "type": "query", "description": "The start date" }, { "name": "endDate", "value": "2022-01-14", "type": "query", "description": "The end date" }, { "name": "compareStartDate", "value": "2022-01-01", "type": "query", "description": "The compare start date" }, { "name": "compareEndDate", "value": "2022-01-07", "type": "query", "description": "The compare end date" } ] }, "docs": "Retrieve impressions summary data filtered by various parameters" }, { "info": { "name": "Get impressions distribution", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/mdsp/impressions/distribution", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "kind", "value": "", "type": "query", "description": "Return what data? Choices: Impressions/Ad Spend/Video Completions/Clicks" }, { "name": "groupBy", "value": "", "type": "query", "description": "Group by?, Choices: creative/adgroup/device/daypart/publisher/channel/audience/state/dma/mediatype" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "xandrId", "value": "", "type": "query", "description": "the advertiser's XandrId" }, { "name": "mediaType", "value": "", "type": "query", "description": "the media types to filter (e.g. Display Retargeting, OTT, etc.)" }, { "name": "creative", "value": "", "type": "query", "description": "the comma-separated creative ids to filter" }, { "name": "publisher", "value": "", "type": "query", "description": "the comma-separated publisher names to filter" }, { "name": "audience", "value": "", "type": "query", "description": "the comma-separated audience names to filter" }, { "name": "ioIds", "value": "", "type": "query", "description": "the comma-separated IO ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated Adready Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "2022-01-08", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "2022-01-14", "type": "query", "description": "the end date" } ] }, "docs": "Get impressions distribution" }, { "info": { "name": "Get daily impressions details", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/mdsp/impressions/daily", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser id" }, { "name": "kind", "value": "", "type": "query", "description": "Return what data? Choices: Impressions / Ad Spend / Video Completions / Clicks" }, { "name": "client", "value": "", "type": "query", "description": "The account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "The advertiser name" }, { "name": "xandrId", "value": "", "type": "query", "description": "The advertiser's XandrId" }, { "name": "mediaType", "value": "", "type": "query", "description": "The media types to filter (e.g. Display Retargeting, OTT, etc.)" }, { "name": "creative", "value": "", "type": "query", "description": "The comma-separated creative ids to filter" }, { "name": "publisher", "value": "", "type": "query", "description": "The comma-separated publisher names to filter" }, { "name": "audience", "value": "", "type": "query", "description": "The comma-separated audience names to filter" }, { "name": "ioIds", "value": "", "type": "query", "description": "The comma-separated IO ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "The comma-separated Adready Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "2022-01-08", "type": "query", "description": "The start date" }, { "name": "endDate", "value": "2022-01-14", "type": "query", "description": "The end date" }, { "name": "compareStartDate", "value": "2022-01-01", "type": "query", "description": "The compare start date" }, { "name": "compareEndDate", "value": "2022-01-07", "type": "query", "description": "The compare end date" }, { "name": "cumulative", "value": "", "type": "query", "description": "Flag to specify cumulative or not." } ] }, "docs": "Return daily impressions details for given filters" }, { "info": { "name": "Get incrementality & brand lift summary", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/lift/summary", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "xandrId", "value": "", "type": "query", "description": "the advertiser's XandrId" }, { "name": "pixel", "value": "", "type": "query", "description": "the FLIP universal pixel id" }, { "name": "showUniques", "value": "", "type": "query", "description": "flag to decide whether to show only uniques or not" }, { "name": "conversionWindow", "value": "", "type": "query", "description": "the conversion window in hours" }, { "name": "mediaType", "value": "", "type": "query", "description": "the media types to filter (e.g. Display Retargeting, OTT, etc.)" }, { "name": "creative", "value": "", "type": "query", "description": "the comma-separated creative ids to filter" }, { "name": "publisher", "value": "", "type": "query", "description": "the comma-separated publisher names to filter" }, { "name": "audience", "value": "", "type": "query", "description": "the comma-separated audience names to filter" }, { "name": "io", "value": "", "type": "query", "description": "the IO name/grouping name" }, { "name": "ioIds", "value": "", "type": "query", "description": "the comma-separated IO ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated Adready Id & start date (separated by |) combination to filter" }, { "name": "attribution", "value": "", "type": "query", "description": "the conversion attribution to be used, either full or partial" }, { "name": "methodology", "value": "", "type": "query", "description": "the methodology to be used, either first_touch/last_touch/linear/time_decay" }, { "name": "event", "value": "", "type": "query", "description": "the event" }, { "name": "category", "value": "", "type": "query", "description": "the pixel category" }, { "name": "subCategory", "value": "", "type": "query", "description": "the comma-separated pixel sub-categories" }, { "name": "liftType", "value": "", "type": "query", "description": "the lift type" }, { "name": "startDate", "value": "2022-01-08", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "2022-01-14", "type": "query", "description": "the end date" } ] }, "docs": "Get incrementality & brand lift summary" }, { "info": { "name": "Get overall pacing for selected insertion orders", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/io_pacing", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Fetches the overall pacing details for the provided insertion orders" }, { "info": { "name": "Get impressions summary", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/impressions/summary", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "kind", "value": "", "type": "query", "description": "the kind of data to be returned, either Impressions / Ad Spend / Video Completions / Clicks" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "xandrId", "value": "", "type": "query", "description": "the advertiser's XandrId" }, { "name": "mediaType", "value": "", "type": "query", "description": "the media types to filter (e.g. Display Retargeting, OTT, etc.)" }, { "name": "creative", "value": "", "type": "query", "description": "the comma-separated creative ids to filter" }, { "name": "publisher", "value": "", "type": "query", "description": "the comma-separated publisher names to filter" }, { "name": "audience", "value": "", "type": "query", "description": "the comma-separated audience names to filter" }, { "name": "ioIds", "value": "", "type": "query", "description": "the comma-separated IO ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated Adready Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "2022-01-08", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "2022-01-14", "type": "query", "description": "the end date" }, { "name": "compareStartDate", "value": "2022-01-01", "type": "query", "description": "the compare start date" }, { "name": "compareEndDate", "value": "2022-01-07", "type": "query", "description": "the compare end date" } ] }, "docs": "Get impressions summary" }, { "info": { "name": "Get impressions distribution", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/impressions/distribution", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "kind", "value": "", "type": "query", "description": "the kind of data to be returned, either Impressions / Ad Spend / Video Completions / Clicks" }, { "name": "groupBy", "value": "", "type": "query", "description": "the field by which data to be grouped, either creative/adgroup/device/daypart/publisher/channel/audience/state/dma/mediatype" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "xandrId", "value": "", "type": "query", "description": "the advertiser's XandrId" }, { "name": "mediaType", "value": "", "type": "query", "description": "the media types to filter (e.g. Display Retargeting, OTT, etc.)" }, { "name": "creative", "value": "", "type": "query", "description": "the comma-separated creative ids to filter" }, { "name": "publisher", "value": "", "type": "query", "description": "the comma-separated publisher names to filter" }, { "name": "audience", "value": "", "type": "query", "description": "the comma-separated audience names to filter" }, { "name": "ioIds", "value": "", "type": "query", "description": "the comma-separated IO ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated Adready Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "2022-01-08", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "2022-01-14", "type": "query", "description": "the end date" } ] }, "docs": "Get impressions distribution" }, { "info": { "name": "Get daily impressions details", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/impressions/daily", "params": [ { "name": "advertiserId", "value": "", "type": "path" }, { "name": "kind", "value": "", "type": "query", "description": "The kind of data to be returned, either Impressions / Ad Spend / Video Completions / Clicks" } ] }, "docs": "Returns daily impression data for a given advertiser" }, { "info": { "name": "Get FLIP pixels by advertiser id", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/flipPixels", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser id" }, { "name": "showAll", "value": "", "type": "query", "description": "Flag to decide whether to show all pixels or only active pixels" } ] }, "docs": "Returns FLIP pixels for the specified advertiser" }, { "info": { "name": "Add new FLIP pixel for an advertiser", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/flipPixels", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new FLIP pixel for the given advertiser ID" }, { "info": { "name": "Get creatives for an advertiser", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/creatives", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "ioIds", "value": "", "type": "query", "description": "the comma-separated IO ids to filter" }, { "name": "startDate", "value": "2022-01-08", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "2022-01-14", "type": "query", "description": "the end date" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated Adready Id & start date (separated by |) combination to filter" } ] }, "docs": "Fetches creatives for a given advertiser" }, { "info": { "name": "Get conversions summary for a FLIP pixel", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/conversions/summary", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "xandrId", "value": "", "type": "query", "description": "the advertiser's XandrId" }, { "name": "pixel", "value": "", "type": "query", "description": "the FLIP universal pixel id" }, { "name": "showUniques", "value": "", "type": "query", "description": "flag to decide whether to show only uniques or not" }, { "name": "conversionWindow", "value": "", "type": "query", "description": "the conversion window in hours" }, { "name": "mediaType", "value": "", "type": "query", "description": "the media types to filter (e.g. Display Retargeting, OTT, etc.)" }, { "name": "creative", "value": "", "type": "query", "description": "the comma-separated creative ids to filter" }, { "name": "publisher", "value": "", "type": "query", "description": "the comma-separated publisher names to filter" }, { "name": "audience", "value": "", "type": "query", "description": "the comma-separated audience names to filter" }, { "name": "ioIds", "value": "", "type": "query", "description": "the comma-separated ioIds ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated Adready Id & start date (separated by |) combination to filter" }, { "name": "attribution", "value": "", "type": "query", "description": "the conversion attribution to be used, either full or partial" }, { "name": "methodology", "value": "", "type": "query", "description": "the methodology to be used, either first_touch/last_touch/linear/time_decay" }, { "name": "event", "value": "", "type": "query", "description": "the event" }, { "name": "category", "value": "", "type": "query", "description": "the pixel category" }, { "name": "subCategory", "value": "", "type": "query", "description": "the comma-separated pixel sub-categories" }, { "name": "startDate", "value": "2022-01-08", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "2022-01-14", "type": "query", "description": "the end date" }, { "name": "compareStartDate", "value": "2022-01-01", "type": "query", "description": "the compare start date" }, { "name": "compareEndDate", "value": "2022-01-07", "type": "query", "description": "the compare end date" } ] }, "docs": "Get conversions summary for a FLIP pixel" }, { "info": { "name": "Get conversions distribution for a FLIP pixel", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/conversions/distribution", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "kind", "value": "", "type": "query", "description": "the kind of data to be returned, either pixel visits or pixel revenue" }, { "name": "groupBy", "value": "", "type": "query", "description": "the field by which data to be grouped, either creative/adgroup/device/daypart/publisher/channel/audience/timesexposed/state/dma/mediatype/subcategories" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "xandrId", "value": "", "type": "query", "description": "the advertiser's XandrId" }, { "name": "pixel", "value": "", "type": "query", "description": "the FLIP universal pixel id" }, { "name": "showUniques", "value": "", "type": "query", "description": "flag to decide whether to show only uniques or not" }, { "name": "conversionWindow", "value": "", "type": "query", "description": "the conversion window in hours" }, { "name": "mediaType", "value": "", "type": "query", "description": "the media types to filter (e.g. Display Retargeting, OTT, etc.)" }, { "name": "creative", "value": "", "type": "query", "description": "the comma-separated creative ids to filter" }, { "name": "publisher", "value": "", "type": "query", "description": "the comma-separated publisher names to filter" }, { "name": "audience", "value": "", "type": "query", "description": "the comma-separated audience names to filter" }, { "name": "ioIds", "value": "", "type": "query", "description": "the comma-separated IO ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated Adready Id & start date (separated by |) combination to filter" }, { "name": "attribution", "value": "", "type": "query", "description": "the conversion attribution to be used, either full or partial" }, { "name": "methodology", "value": "", "type": "query", "description": "the methodology to be used, either first_touch/last_touch/linear/time_decay" }, { "name": "event", "value": "", "type": "query", "description": "the event" }, { "name": "category", "value": "", "type": "query", "description": "the pixel category" }, { "name": "subCategory", "value": "", "type": "query", "description": "the comma-separated pixel sub-categories" }, { "name": "startDate", "value": "2022-01-08", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "2022-01-14", "type": "query", "description": "the end date" } ] }, "docs": "Get conversions distribution for a FLIP pixel" }, { "info": { "name": "Get daily pixel visits details", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/conversions/daily", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser ID" }, { "name": "kind", "value": "", "type": "query", "description": "The kind of data to be returned" } ] }, "docs": "Returns pixel visit or revenue data for a specific advertiser over a time range." }, { "info": { "name": "Get campaigns for an Advertiser and selected IO", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/brand_lift/campaigns", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "intCampaignId", "value": "", "type": "query", "description": "the IO/Campaign Id" }, { "name": "io", "value": "", "type": "query", "description": "the IO name/grouping name" }, { "name": "pioCampaignId", "value": "", "type": "query", "description": "the PIO Campaign Id" } ] }, "docs": "Get campaigns for an Advertiser and selected IO" }, { "info": { "name": "Create campaign for an Advertiser and selected IO", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/brand_lift/campaigns", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "intCampaignId", "value": "", "type": "query", "description": "the Campaign/IO Id" }, { "name": "io", "value": "", "type": "query", "description": "the IO name/grouping name" }, { "name": "pioCampaignId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create campaign for an Advertiser and selected IO" }, { "info": { "name": "Get publishers for an advertiser", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/publishers", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "ioIds", "value": "", "type": "query", "description": "the comma-separated IO ids to filter" }, { "name": "startDate", "value": "2022-01-08", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "2022-01-14", "type": "query", "description": "the end date" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated Adready Id & start date (separated by |) combination to filter" } ] }, "docs": "Fetches the list of publishers for the specified advertiser" }, { "info": { "name": "Get incremental reach metric", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/performance/metrics/incrementalreach", "params": [ { "name": "startDate", "value": "", "type": "query", "description": "The start date" }, { "name": "endDate", "value": "", "type": "query", "description": "The end date" }, { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser ID" }, { "name": "adGroups", "value": "", "type": "query", "description": "Comma-separated AdReady ID & start date (separated by |) combinations" }, { "name": "compareStartDate", "value": "", "type": "query", "description": "Compare start date" }, { "name": "compareEndDate", "value": "", "type": "query", "description": "Compare end date" }, { "name": "client", "value": "", "type": "query", "description": "The account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "The advertiser name" } ] }, "docs": "Returns incremental reach metrics by advertiser and client over specified date range" }, { "info": { "name": "Get unique insertion order names for an advertiser", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/io_names", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "showAll", "value": "", "type": "query", "description": "flag to decide whether to include Adready IOs in the response or not" }, { "name": "includeNonFlip", "value": "", "type": "query", "description": "flag to decide whether to include non-flip IOs in the response or not" }, { "name": "currentPage", "value": "", "type": "query", "description": "for pagination" } ] }, "docs": "Get unique insertion order names for an advertiser" }, { "info": { "name": "Fetch FLIP pixel fires", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/flipPixels/:pixelId/fires", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser ID" }, { "name": "pixelId", "value": "", "type": "path", "description": "The FLIP pixel ID" }, { "name": "category", "value": "", "type": "query", "description": "Comma-separated pixel categories" }, { "name": "subCategory", "value": "", "type": "query", "description": "Comma-separated pixel sub-categories" }, { "name": "startDate", "value": "", "type": "query", "description": "The start date" }, { "name": "endDate", "value": "", "type": "query", "description": "The end date" }, { "name": "offset", "value": "", "type": "query", "description": "Number of records to skip" }, { "name": "limit", "value": "", "type": "query", "description": "Max number of records to return" } ] }, "docs": "Returns pixel fires for the specified pixel and advertiser, with support for filters and pagination." }, { "info": { "name": "Get FLIP pixel fires summary", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/flipPixels/:pixelId/fires/summary", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser id" }, { "name": "pixelId", "value": "", "type": "path", "description": "The pixel id" }, { "name": "category", "value": "", "type": "query", "description": "The comma-separated pixel categories" }, { "name": "subCategory", "value": "", "type": "query", "description": "The comma-separated pixel sub-categories" }, { "name": "startDate", "value": "", "type": "query", "description": "The start date" }, { "name": "endDate", "value": "", "type": "query", "description": "The end date" } ] }, "docs": "Returns summary of pixel fires for a given pixel ID and date range" }, { "info": { "name": "Get daily FLIP pixel fires", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/flipPixels/:pixelId/fires/daily", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser ID" }, { "name": "pixelId", "value": "", "type": "path", "description": "The FLIP pixel ID" }, { "name": "category", "value": "", "type": "query", "description": "Comma-separated pixel categories" }, { "name": "subCategory", "value": "", "type": "query", "description": "Comma-separated pixel sub-categories" }, { "name": "startDate", "value": "", "type": "query", "description": "The start date" }, { "name": "endDate", "value": "", "type": "query", "description": "The end date" } ] }, "docs": "Returns daily pixel fires for a given advertiser and pixel ID." }, { "info": { "name": "Fetch FLIP pixel categories", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/flipPixels/:pixelId/categories", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser ID" }, { "name": "pixelId", "value": "", "type": "path", "description": "The FLIP pixel ID" }, { "name": "startDate", "value": "", "type": "query", "description": "The start date (format: yyyy-MM-dd)" }, { "name": "endDate", "value": "", "type": "query", "description": "The end date (format: yyyy-MM-dd)" } ] }, "docs": "Returns a list of pixel events (categories) for the given pixel ID and advertiser ID within the specified date range" }, { "info": { "name": "Get conversion events for an advertiser", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/events", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "xandrId", "value": "", "type": "query", "description": "the advertiser's XandrId" }, { "name": "pixelId", "value": "", "type": "query", "description": "the advertiser's pixelId" } ] }, "docs": "Fetches conversion events for a given advertiser" }, { "info": { "name": "Get lift types for brand lift", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/brand_lift/types", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "intCampaignId", "value": "", "type": "query", "description": "the IO/Campaign Id" }, { "name": "io", "value": "", "type": "query", "description": "the IO name/grouping name" }, { "name": "pioCampaignId", "value": "", "type": "query", "description": "the PIO Campaign Id" } ] }, "docs": "Get lift types for brand lift" }, { "info": { "name": "List Template Questions", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/brand_lift/template_questions", "params": [ { "name": "advertiserId", "value": "", "type": "path" }, { "name": "usage", "value": "", "type": "query" }, { "name": "countryLanguageId", "value": "", "type": "query" }, { "name": "industryId", "value": "", "type": "query" } ] }, "docs": "List Template Questions" }, { "info": { "name": "List Industries", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/brand_lift/industries" }, "docs": "List Industries" }, { "info": { "name": "Get group by for brand lift", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/brand_lift/groupBy", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "intCampaignId", "value": "", "type": "query", "description": "the IO/Campaign Id" }, { "name": "io", "value": "", "type": "query", "description": "the IO name/grouping name" }, { "name": "pioCampaignId", "value": "", "type": "query", "description": "the PIO Campaign Id" } ] }, "docs": "Get group by for brand lift" }, { "info": { "name": "Get brand lift distribution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/brand_lift/distribution", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "intCampaignId", "value": "", "type": "query", "description": "the IO/Campaign Id" }, { "name": "io", "value": "", "type": "query", "description": "the IO name/grouping name" }, { "name": "groupBy", "value": "", "type": "query", "description": "the field by which data to be grouped, either creative/publisher/audience/overall" }, { "name": "liftType", "value": "", "type": "query", "description": "the lift type" }, { "name": "pioCampaignId", "value": "", "type": "query", "description": "the PIO Campaign Id" } ] }, "docs": "Get brand lift distribution" }, { "info": { "name": "List Country Languages", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/brand_lift/country_languages" }, "docs": "List Country Languages" }, { "info": { "name": "Get campaigns stats for an Advertiser and selected IO", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/brand_lift/campaignsStats", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "intCampaignId", "value": "", "type": "query", "description": "the IO/Campaign Id" }, { "name": "io", "value": "", "type": "query", "description": "the IO name/grouping name" }, { "name": "pioCampaignId", "value": "", "type": "query", "description": "the PIO Campaign Id" } ] }, "docs": "Get campaigns stats for an Advertiser and selected IO" }, { "info": { "name": "Retrieve single campaign detail for a given campaign id", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/brand_lift/campaign/:bl_campaign_id", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "bl_campaign_id", "value": "", "type": "path", "description": "the BL campaign id" } ] }, "docs": "Retrieve single campaign detail for a given campaign id" } ] }, { "info": { "name": "account-controller", "type": "folder" }, "items": [ { "info": { "name": "update_10", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/accounts/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "provisionDefaultAccountData", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/accounts/:accountId/provisionDefaultAccountData", "params": [ { "name": "accountId", "value": "", "type": "path" } ] } }, { "info": { "name": "mapUsers_1", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/accounts/:accountId/mapUsers", "params": [ { "name": "accountId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "mapUsersAndDropdowns", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/accounts/:accountId/mapUsersAndDropdowns", "params": [ { "name": "accountId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "refreshWhitelabelFiles", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/accounts/refresh_wl_files/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "getAll_4", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/accounts" } }, { "info": { "name": "create_13", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/accounts", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "getAccount", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/accounts/:accountId", "params": [ { "name": "accountId", "value": "", "type": "path" }, { "name": "adreadyPlus", "value": "", "type": "query" } ] } }, { "info": { "name": "getUserbyAccountAndType", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/accounts/:accountId/dropdowns/:type", "params": [ { "name": "accountId", "value": "", "type": "path" }, { "name": "type", "value": "", "type": "path" } ] } }, { "info": { "name": "getDropdownUserbyAccount", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/accounts/:accountId/dropdownUsers", "params": [ { "name": "accountId", "value": "", "type": "path" } ] } }, { "info": { "name": "getAllAccountsByUserId", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/accounts/user/:userId", "params": [ { "name": "userId", "value": "", "type": "path" } ] } }, { "info": { "name": "isPrefixExist", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/accounts/prefixExist", "params": [ { "name": "prefix", "value": "", "type": "query" } ] } }, { "info": { "name": "isNameExist", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/accounts/nameExist", "params": [ { "name": "name", "value": "", "type": "query" } ] } }, { "info": { "name": "getAllManagedAccountsByUserId", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/accounts/managed/:userId", "params": [ { "name": "userId", "value": "", "type": "path" } ] } }, { "info": { "name": "isAbbreviationExist", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/accounts/abbreviationExist", "params": [ { "name": "abbreviation", "value": "", "type": "query" } ] } }, { "info": { "name": "removeUser", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/accounts/:accountId/removeUser", "params": [ { "name": "accountId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "removeUserFromDropdown", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/accounts/:accountId/dropdown/:id", "params": [ { "name": "accountId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "App Console: Solution Management", "type": "folder" }, "items": [ { "info": { "name": "getSolution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/solutions/:solutionId", "params": [ { "name": "solutionId", "value": "", "type": "path" } ] } }, { "info": { "name": "update_11", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/ac/solutions/:solutionId", "params": [ { "name": "solutionId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "delete_8", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/ac/solutions/:solutionId", "params": [ { "name": "solutionId", "value": "", "type": "path" } ] } }, { "info": { "name": "getById", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertiserSolution/id/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "update_13", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/ac/advertiserSolution/id/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "delete_10", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/ac/advertiserSolution/id/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "getAll_5", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/solutions" } }, { "info": { "name": "create_14", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/ac/solutions", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "getAll_6", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertiserSolution" } }, { "info": { "name": "create_16", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/ac/advertiserSolution", "body": { "type": "json", "data": "{}" } } } ] }, { "info": { "name": "App Console: Report Template Management", "type": "folder" }, "items": [ { "info": { "name": "get_7", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/reportTemplate/:reportTemplateId", "params": [ { "name": "reportTemplateId", "value": "", "type": "path" }, { "name": "advertiserId", "value": "", "type": "path" } ] } }, { "info": { "name": "update_12", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/reportTemplate/:reportTemplateId", "params": [ { "name": "reportTemplateId", "value": "", "type": "path" }, { "name": "advertiserId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "delete_9", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/reportTemplate/:reportTemplateId", "params": [ { "name": "reportTemplateId", "value": "", "type": "path" }, { "name": "advertiserId", "value": "", "type": "path" } ] } }, { "info": { "name": "create_15", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/reportTemplate", "params": [ { "name": "advertiserId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "run", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/reportTemplate/run", "params": [ { "name": "advertiserId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "queryTemplate", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/reportTemplate/preset/run", "params": [ { "name": "advertiserId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "getReportGenerationLogs", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/reportTemplate/:reportTemplateId/reportGenerationLogs", "params": [ { "name": "reportTemplateId", "value": "", "type": "path" }, { "name": "advertiserId", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" } ] } }, { "info": { "name": "getReportTemplateByUserId", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/reportTemplate/getUserSavedReports", "params": [ { "name": "advertiserId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "sign-up-controller", "type": "folder" }, "items": [ { "info": { "name": "sendVerificationEmail", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/sendVerificationEmail", "params": [ { "name": "userId", "value": "", "type": "query" }, { "name": "app", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "api-controller", "type": "folder" }, "items": [ { "info": { "name": "updateLineItemStatus", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/run/updateLineItemStatus", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "updateLineItemStatusLive", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/run/updateLineItemStatusLive", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "runReport", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/run/sendDailySummaryReport", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "generateReports", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/run/generateReports", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "runFlipPixelActivityController", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/run/flip_pixel_activity_scheduler", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "runExportScheduleJob", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/run/exportScheduleJob", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "updateReportGenerationLogStatus", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/reportGenerationLog/updateStatus", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "getWorkflowOptions", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/workflowOptions" } }, { "info": { "name": "getAllVerificationPartners", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/verificationPartners" } }, { "info": { "name": "getTrackingTypes", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/trackingTypes" } }, { "info": { "name": "getTaskTypeOptions", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/taskTypeOptions" } }, { "info": { "name": "getTargetableElements", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/targetingElements" } }, { "info": { "name": "getTargetableElementOptions", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/targetableElement/:targetableElementId/options", "params": [ { "name": "targetableElementId", "value": "", "type": "path" }, { "name": "term", "value": "", "type": "query" }, { "name": "source", "value": "", "type": "query" } ] } }, { "info": { "name": "getAllStatusOptions", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/statusOptions/:type", "params": [ { "name": "type", "value": "", "type": "path" } ] } }, { "info": { "name": "getRoles", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/roles" } }, { "info": { "name": "getProductTypeById", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/productTypes/:productTypeId", "params": [ { "name": "productTypeId", "value": "", "type": "path" } ] } }, { "info": { "name": "getTargetableElements_1", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/productTypes/:productTypeId/targetingTypes/:targetingType", "params": [ { "name": "productTypeId", "value": "", "type": "path" }, { "name": "targetingType", "value": "", "type": "path" }, { "name": "accountId", "value": "", "type": "query" } ] } }, { "info": { "name": "getTargetableElementsByLevel", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/productTypes/:productTypeId/targetingTypes/:targetingType/level/:level", "params": [ { "name": "productTypeId", "value": "", "type": "path" }, { "name": "targetingType", "value": "", "type": "path" }, { "name": "level", "value": "", "type": "path" } ] } }, { "info": { "name": "getKpiOptions", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/productTypes/:productTypeId/kpiOptions", "params": [ { "name": "productTypeId", "value": "", "type": "path" } ] } }, { "info": { "name": "goalOptions", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/productTypes/:productTypeId/goalOptions", "params": [ { "name": "productTypeId", "value": "", "type": "path" } ] } }, { "info": { "name": "getProductCategories", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/productCategories" } }, { "info": { "name": "getProductCategoryById", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/productCategories/:productCategoryId", "params": [ { "name": "productCategoryId", "value": "", "type": "path" } ] } }, { "info": { "name": "getPriceTypeOptions", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/priceTypeOptions" } }, { "info": { "name": "getMarketingObjectives", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/options/marketingObjectives" } }, { "info": { "name": "getLocations", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/options/locations" } }, { "info": { "name": "getIndustries", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/options/industries" } }, { "info": { "name": "Get budget ranges", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/options/budgetRanges" }, "docs": "Get budget ranges" }, { "info": { "name": "getKpiOptions_1", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/kpiOptions" } }, { "info": { "name": "getAllProductHierarchies", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/hierarchies", "params": [ { "name": "accountId", "value": "", "type": "query" }, { "name": "accountType", "value": "", "type": "query" } ] } }, { "info": { "name": "getFlagOptions", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/flagOptions" } }, { "info": { "name": "getAllBrandSafetyLevels", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/brandSafetyLevels" } }, { "info": { "name": "getBillingTypeOptions", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/billingTypeOptions" } }, { "info": { "name": "getApplications", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/applications" } } ] }, { "info": { "name": "pixel-controller", "type": "folder" }, "items": [ { "info": { "name": "getAll_2", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/pixels" } }, { "info": { "name": "create_4", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/pixels", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "get_8", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/pixels/:pixelId", "params": [ { "name": "pixelId", "value": "", "type": "path" } ] } }, { "info": { "name": "getAllByAdvertiser", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/pixels/advertiser/:advertiserId", "params": [ { "name": "advertiserId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "Flip PixelFile", "type": "folder" }, "items": [ { "info": { "name": "dumpToBucket", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/flipPixelsFile/dumpToBucket", "params": [ { "name": "pretty", "value": "", "type": "query" }, { "name": "filePath", "value": "", "type": "query" } ] } }, { "info": { "name": "dumpToBucket_1", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/flipPixelsFile/dumpToBucketCronAuth", "params": [ { "name": "pretty", "value": "", "type": "query" }, { "name": "filePath", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } } } ] }, { "info": { "name": "file-controller", "type": "folder" }, "items": [ { "info": { "name": "uploadFile", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/files/:orderId/lineItems/:lineItemId", "params": [ { "name": "type", "value": "", "type": "query" }, { "name": "orderId", "value": "", "type": "path" }, { "name": "lineItemId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "savePublisherLogo", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/files/publisher/:publisherId", "params": [ { "name": "publisherId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "saveLogo", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/files/organizations/:organizationId", "params": [ { "name": "type", "value": "", "type": "query" }, { "name": "organizationId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "getFile", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/files/:fileId", "params": [ { "name": "fileId", "value": "", "type": "path" } ] } }, { "info": { "name": "downloadPlanFile", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/files/download/plan/:planId", "params": [ { "name": "planId", "value": "", "type": "path" } ] } }, { "info": { "name": "downloadFile", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/files/download/orders/:orderId/:lineItemId/:fileName", "params": [ { "name": "fileName", "value": "", "type": "path" }, { "name": "orderId", "value": "", "type": "path" }, { "name": "lineItemId", "value": "", "type": "path" }, { "name": "download", "value": "", "type": "query" } ] } }, { "info": { "name": "downloadFile_1", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/files/download/orders/:orderId/:fileName", "params": [ { "name": "fileName", "value": "", "type": "path" }, { "name": "orderId", "value": "", "type": "path" }, { "name": "download", "value": "", "type": "query" } ] } }, { "info": { "name": "downloadFile_2", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/files/download/tmp/:fileName", "params": [ { "name": "fileName", "value": "", "type": "path" }, { "name": "download", "value": "", "type": "query" } ] } }, { "info": { "name": "downloadFile_3", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/files/download/:fileName", "params": [ { "name": "fileName", "value": "", "type": "path" }, { "name": "download", "value": "", "type": "query" } ] } }, { "info": { "name": "downloadLineItemFile", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/files/download/line-item/:lineItemId", "params": [ { "name": "lineItemId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "auth-controller", "type": "folder" }, "items": [ { "info": { "name": "validateResetPasswordToken", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/auth/validate_token", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "ResetPassword", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/auth/reset_password", "params": [ { "name": "app", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "authenticatePlusUser", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/auth/plus_login" } }, { "info": { "name": "authenticateUser", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/auth/login", "params": [ { "name": "app", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "loginAhUser", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/auth/loginC360User" } }, { "info": { "name": "createPassword", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/auth/forgot_password", "params": [ { "name": "app", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "createPassword_1", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/auth/create_password", "body": { "type": "json", "data": "{}" } } } ] }, { "info": { "name": "advertiser", "type": "folder" }, "items": [ { "info": { "name": "Get media types for an advertiser", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/media_types", "params": [ { "name": "advertiserId", "value": "", "type": "query", "description": "the advertiser id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "ioIds", "value": "", "type": "query", "description": "the comma-separated IO ids to filter" }, { "name": "startDate", "value": "2022-01-08", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "2022-01-14", "type": "query", "description": "the end date" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated Adready Id & start date (separated by |) combination to filter" }, { "name": "includeNonFlip", "value": "", "type": "query", "description": "flag to decide whether to include non-flip IOs in the response or not" } ] }, "docs": "Get media types for an advertiser" }, { "info": { "name": "Get audiences for an advertiser", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/audiences", "params": [ { "name": "advertiserId", "value": "", "type": "query", "description": "the advertiser id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "ioIds", "value": "", "type": "query", "description": "the comma-separated IO ids to filter" }, { "name": "startDate", "value": "2022-01-08", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "2022-01-14", "type": "query", "description": "the end date" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated Adready Id & start date (separated by |) combination to filter" } ] }, "docs": "Get audiences for an advertiser" } ] }, { "info": { "name": "Incrementality", "type": "folder" }, "items": [ { "info": { "name": "Get incrementality distribution", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/incrementality/distribution", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "groupBy", "value": "", "type": "query", "description": "the field by which data to be grouped, either creative/publisher/audience/mediatype/adgroup/overall" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "xandrId", "value": "", "type": "query", "description": "the advertiser's XandrId" }, { "name": "pixel", "value": "", "type": "query", "description": "the FLIP universal pixel id" }, { "name": "showUniques", "value": "", "type": "query", "description": "flag to decide whether to show only uniques or not" }, { "name": "conversionWindow", "value": "", "type": "query", "description": "the conversion window in hours" }, { "name": "mediaType", "value": "", "type": "query", "description": "the media types to filter (e.g. Display Retargeting, OTT, etc.)" }, { "name": "creative", "value": "", "type": "query", "description": "the comma-separated creative ids to filter" }, { "name": "publisher", "value": "", "type": "query", "description": "the comma-separated publisher names to filter" }, { "name": "audience", "value": "", "type": "query", "description": "the comma-separated audience names to filter" }, { "name": "ioIds", "value": "", "type": "query", "description": "the comma-separated IO ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated Adready Id & start date (separated by |) combination to filter" }, { "name": "attribution", "value": "", "type": "query", "description": "the conversion attribution to be used, either full or partial" }, { "name": "methodology", "value": "", "type": "query", "description": "the methodology to be used, either first_touch/last_touch/linear/time_decay" }, { "name": "event", "value": "", "type": "query", "description": "the event" }, { "name": "category", "value": "", "type": "query", "description": "the pixel category" }, { "name": "subCategory", "value": "", "type": "query", "description": "the comma-separated pixel sub-categories" }, { "name": "startDate", "value": "", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "", "type": "query", "description": "the end date" } ] }, "docs": "Provides incrementality distribution data" }, { "info": { "name": "Get Halo Effect data", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/advertisers/:advertiserId/incrementality/haloEffect", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "xandrId", "value": "", "type": "query", "description": "the advertiser's XandrId" }, { "name": "pixel", "value": "", "type": "query", "description": "the FLIP universal pixel id" }, { "name": "showUniques", "value": "", "type": "query", "description": "flag to decide whether to show only uniques or not" }, { "name": "conversionWindow", "value": "", "type": "query", "description": "the conversion window in hours" }, { "name": "mediaType", "value": "", "type": "query", "description": "the media types to filter (e.g. Display Retargeting, OTT, etc.)" }, { "name": "creative", "value": "", "type": "query", "description": "the comma-separated creative ids to filter" }, { "name": "publisher", "value": "", "type": "query", "description": "the comma-separated publisher names to filter" }, { "name": "audience", "value": "", "type": "query", "description": "the comma-separated audience names to filter" }, { "name": "ioIds", "value": "", "type": "query", "description": "the comma-separated IO ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated Adready Id & start date (separated by |) combination to filter" }, { "name": "attribution", "value": "", "type": "query", "description": "the conversion attribution to be used, either full or partial" }, { "name": "methodology", "value": "", "type": "query", "description": "the methodology to be used, either first_touch/last_touch/linear/time_decay" }, { "name": "event", "value": "", "type": "query", "description": "the event" }, { "name": "category", "value": "", "type": "query", "description": "the pixel category" }, { "name": "subCategory", "value": "", "type": "query", "description": "the comma-separated pixel sub-categories" }, { "name": "startDate", "value": "", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "", "type": "query", "description": "the end date" } ] }, "docs": "Provides halo effect data" } ] }, { "info": { "name": "App Console: Brand", "type": "folder" }, "items": [ { "info": { "name": "Get dimension-wise measurements & metrics report for Performance Brand solution", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/brand/reports", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser id" }, { "name": "solutionId", "value": "", "type": "path", "description": "The solution id" }, { "name": "dimension", "value": "", "type": "query", "description": "The dimension by which data is grouped" }, { "name": "client", "value": "", "type": "query", "description": "The account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "The advertiser name" }, { "name": "mediaTypes", "value": "", "type": "query", "description": "The media types to filter (e.g. Display Retargeting, OTT, etc.)" }, { "name": "creatives", "value": "", "type": "query", "description": "The comma-separated creative ids to filter" }, { "name": "audiences", "value": "", "type": "query", "description": "The comma-separated audience names to filter" }, { "name": "campaignIds", "value": "", "type": "query", "description": "The comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "The comma-separated AdReady Id & start date (separated by |)" }, { "name": "startDate", "value": "2023-06-08", "type": "query", "description": "The start date" }, { "name": "endDate", "value": "2023-06-14", "type": "query", "description": "The end date" }, { "name": "standardRequest", "value": "", "type": "query" }, { "name": "conversionApiRequest", "value": "", "type": "query" }, { "name": "schedulingRequest", "value": "", "type": "query" }, { "name": "creative", "value": "", "type": "query" }, { "name": "audience", "value": "", "type": "query" }, { "name": "mediaType", "value": "", "type": "query" }, { "name": "ioIds", "value": "", "type": "query" } ] }, "docs": "Groups data by one of: overall, day, campaign, adgroup, mediatype, creative, audience, country, state, dma, device" }, { "info": { "name": "Get dimension-wise top performing metrics for Performance Brand solution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/brand/top_performers", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser ID" }, { "name": "solutionId", "value": "", "type": "path", "description": "The solution ID" }, { "name": "dimension", "value": "", "type": "query", "description": "Comma-separated dimensions to group by (e.g. creative,audience)" }, { "name": "client", "value": "", "type": "query", "description": "The account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "The advertiser name" }, { "name": "mediaTypes", "value": "", "type": "query", "description": "Comma-separated media types (e.g. Display Retargeting, OTT, etc.)" }, { "name": "creatives", "value": "", "type": "query", "description": "Comma-separated creative IDs" }, { "name": "audiences", "value": "", "type": "query", "description": "Comma-separated audience names" }, { "name": "campaignIds", "value": "", "type": "query", "description": "Comma-separated campaign IDs" }, { "name": "adGroups", "value": "", "type": "query", "description": "Comma-separated AdReady ID and start date (| separated)" }, { "name": "startDate", "value": "", "type": "query", "description": "Start date" }, { "name": "endDate", "value": "", "type": "query", "description": "End date" } ] }, "docs": "Returns top-performing metrics grouped by specified dimensions" }, { "info": { "name": "Get summary for Performance Brand solution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/brand/summary", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "solutionId", "value": "", "type": "path", "description": "the solution id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "mediaTypes", "value": "", "type": "query", "description": "the media types to filter (e.g. Display Retargeting, OTT, etc.)" }, { "name": "creatives", "value": "", "type": "query", "description": "the comma-separated creative ids to filter" }, { "name": "audiences", "value": "", "type": "query", "description": "the comma-separated audience names to filter" }, { "name": "pixelIds", "value": "", "type": "query", "description": "the comma-separated pixel ids to filter" }, { "name": "campaignIds", "value": "", "type": "query", "description": "the comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated AdReady Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "2023-06-08", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "2023-06-14", "type": "query", "description": "the end date" }, { "name": "compareStartDate", "value": "2023-06-01", "type": "query", "description": "the compare start date" }, { "name": "compareEndDate", "value": "2023-06-07", "type": "query", "description": "the compare end date" } ] }, "docs": "Get summary for Performance Brand solution" }, { "info": { "name": "Get dimension-wise measurements & metrics for Performance Brand solution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/brand/performance", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser id" }, { "name": "solutionId", "value": "", "type": "path", "description": "The solution id" }, { "name": "dimension", "value": "", "type": "query", "description": "The dimension to group by" }, { "name": "client", "value": "", "type": "query", "description": "The account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "The advertiser name" }, { "name": "mediaTypes", "value": "", "type": "query", "description": "Comma-separated media types (e.g. Display Retargeting, OTT)" }, { "name": "creatives", "value": "", "type": "query", "description": "Comma-separated creative ids" }, { "name": "audiences", "value": "", "type": "query", "description": "Comma-separated audience names" }, { "name": "campaignIds", "value": "", "type": "query", "description": "Comma-separated campaign ids" }, { "name": "adGroups", "value": "", "type": "query", "description": "Comma-separated AdReady Id & start date (separated by |)" }, { "name": "startDate", "value": "", "type": "query", "description": "Start date (e.g. 2023-06-08)" }, { "name": "endDate", "value": "", "type": "query", "description": "End date (e.g. 2023-06-14)" }, { "name": "standardRequest", "value": "", "type": "query" } ] }, "docs": "Returns grouped data by dimension: campaign, adgroup, mediatype, creative, audience, country, state, dma, or device." }, { "info": { "name": "Get dimension-wise metrics for Performance Brand solution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/brand/metrics/distribution", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser ID" }, { "name": "solutionId", "value": "", "type": "path", "description": "The solution ID" }, { "name": "metric", "value": "", "type": "query", "description": "Metric to return" }, { "name": "dimension", "value": "", "type": "query", "description": "Group by dimension" }, { "name": "client", "value": "", "type": "query", "description": "The account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "The advertiser name" }, { "name": "mediaTypes", "value": "", "type": "query", "description": "Comma-separated media types (e.g. Display Retargeting, OTT, etc.)" }, { "name": "creatives", "value": "", "type": "query", "description": "Comma-separated creative IDs" }, { "name": "audiences", "value": "", "type": "query", "description": "Comma-separated audience names" }, { "name": "pixelIds", "value": "", "type": "query", "description": "Comma-separated pixel IDs" }, { "name": "campaignIds", "value": "", "type": "query", "description": "Comma-separated campaign IDs" }, { "name": "adGroups", "value": "", "type": "query", "description": "Comma-separated AdReady ID & start date (separated by |)" }, { "name": "startDate", "value": "", "type": "query", "description": "The start date" }, { "name": "endDate", "value": "", "type": "query", "description": "The end date" } ] }, "docs": "Returns grouped metrics (e.g., CTR, CPC) by dimension (e.g., campaign, adgroup)" }, { "info": { "name": "Get daily metrics for Performance Brand solution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/brand/metrics/daily", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser id" }, { "name": "solutionId", "value": "", "type": "path", "description": "The solution id" }, { "name": "metric", "value": "", "type": "query", "description": "The metric like ctr or vcr" }, { "name": "client", "value": "", "type": "query", "description": "The account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "The advertiser name" }, { "name": "mediaTypes", "value": "", "type": "query", "description": "The media types to filter (e.g. Display Retargeting, OTT, etc.)" }, { "name": "creatives", "value": "", "type": "query", "description": "Comma-separated creative ids to filter" }, { "name": "audiences", "value": "", "type": "query", "description": "Comma-separated audience names to filter" }, { "name": "pixelIds", "value": "", "type": "query", "description": "Comma-separated pixel ids to filter" }, { "name": "campaignIds", "value": "", "type": "query", "description": "Comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "Comma-separated AdReady Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "2023-06-08", "type": "query", "description": "The start date" }, { "name": "endDate", "value": "2023-06-14", "type": "query", "description": "The end date" }, { "name": "compareStartDate", "value": "2023-06-01", "type": "query", "description": "The compare start date" }, { "name": "compareEndDate", "value": "2023-06-07", "type": "query", "description": "The compare end date" } ] }, "docs": "Retrieve daily metrics filtered by various criteria" }, { "info": { "name": "Get dimension-wise measurements for Performance Brand solution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/brand/measurements/distribution", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser id" }, { "name": "solutionId", "value": "", "type": "path", "description": "The solution id" }, { "name": "measurement", "value": "", "type": "query", "description": "Measurement to return" }, { "name": "dimension", "value": "", "type": "query", "description": "Group by dimension" }, { "name": "client", "value": "", "type": "query", "description": "The account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "The advertiser name" }, { "name": "mediaTypes", "value": "", "type": "query", "description": "Comma-separated media types (e.g. Display Retargeting, OTT)" }, { "name": "creatives", "value": "", "type": "query", "description": "Comma-separated creative ids" }, { "name": "audiences", "value": "", "type": "query", "description": "Comma-separated audience names" }, { "name": "pixelIds", "value": "", "type": "query", "description": "Comma-separated pixel ids" }, { "name": "campaignIds", "value": "", "type": "query", "description": "Comma-separated campaign ids" }, { "name": "adGroups", "value": "", "type": "query", "description": "Comma-separated AdReady Id & start date (separated by |)" }, { "name": "startDate", "value": "", "type": "query", "description": "Start date" }, { "name": "endDate", "value": "", "type": "query", "description": "End date" }, { "name": "standardRequest", "value": "", "type": "query" } ] }, "docs": "Returns grouped measurement data (e.g. impressions, spend) by a specified dimension." }, { "info": { "name": "Get daily measurements for Performance Brand solution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/brand/measurements/daily", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser id" }, { "name": "solutionId", "value": "", "type": "path", "description": "The solution id" }, { "name": "measurement", "value": "", "type": "query", "description": "The measurement to be returned, either Impressions / Spend / Clicks / Video Completions / Conversions" }, { "name": "client", "value": "", "type": "query", "description": "The account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "The advertiser name" }, { "name": "mediaTypes", "value": "", "type": "query", "description": "The media types to filter (e.g. Display Retargeting, OTT, etc.)" }, { "name": "creatives", "value": "", "type": "query", "description": "Comma-separated creative ids to filter" }, { "name": "audiences", "value": "", "type": "query", "description": "Comma-separated audience names to filter" }, { "name": "pixelIds", "value": "", "type": "query", "description": "Comma-separated pixel ids to filter" }, { "name": "campaignIds", "value": "", "type": "query", "description": "Comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "Comma-separated AdReady Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "2023-06-08", "type": "query", "description": "The start date" }, { "name": "endDate", "value": "2023-06-14", "type": "query", "description": "The end date" }, { "name": "compareStartDate", "value": "2023-06-01", "type": "query", "description": "The compare start date" }, { "name": "compareEndDate", "value": "2023-06-07", "type": "query", "description": "The compare end date" } ] }, "docs": "Returns daily measurement data filtered by various criteria" } ] }, { "info": { "name": "App Console", "type": "folder" }, "items": [ { "info": { "name": "Get ad groups for an advertiser as per the solution id", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/ad_groups", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "solutionId", "value": "", "type": "query", "description": "the solution id" }, { "name": "campaignIds", "value": "", "type": "query", "description": "the comma-separated Campaign ids to filter" }, { "name": "startDate", "value": "2023-06-08", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "2023-06-14", "type": "query", "description": "the end date" } ] }, "docs": "Get ad groups for an advertiser as per the solution id" }, { "info": { "name": "Get list of solutions for an advertiser", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions", "params": [ { "name": "advertiserId", "value": "", "type": "path" } ] }, "docs": "Get list of solutions for an advertiser" }, { "info": { "name": "Get conversion pixels for an advertiser as per the solution id", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/pixels", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "solutionId", "value": "", "type": "query", "description": "the solution id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "campaignIds", "value": "", "type": "query", "description": "the comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated AdReady Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "", "type": "query", "description": "the end date" } ] }, "docs": "Get conversion pixels for an advertiser as per the solution id" }, { "info": { "name": "Get mediatypes for an advertiser as per the solution id", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/mediatypes", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "solutionId", "value": "", "type": "query", "description": "the solution id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "campaignIds", "value": "", "type": "query", "description": "the comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated AdReady Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "2023-06-08", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "2023-06-14", "type": "query", "description": "the end date" } ] }, "docs": "Get mediatypes for an advertiser as per the solution id" }, { "info": { "name": "Get match types for an advertiser as per the solution id", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/matchtypes", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "solutionId", "value": "", "type": "query", "description": "the solution id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "campaignIds", "value": "", "type": "query", "description": "the comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated AdReady Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "", "type": "query", "description": "the end date" } ] }, "docs": "Fetch match types for an advertiser as per the solution id" }, { "info": { "name": "Get keywords for an advertiser as per the solution id", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/keywords", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "solutionId", "value": "", "type": "query", "description": "the solution id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "campaignIds", "value": "", "type": "query", "description": "the comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated AdReady Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "", "type": "query", "description": "the end date" } ] }, "docs": "Fetch keywords for an advertiser as per the solution id" }, { "info": { "name": "Get creatives for an advertiser as per the solution id", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/creatives", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "solutionId", "value": "", "type": "query", "description": "the solution id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "campaignIds", "value": "", "type": "query", "description": "the comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated AdReady Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "", "type": "query", "description": "the end date" } ] }, "docs": "Get creatives for an advertiser as per the solution id" }, { "info": { "name": "Get campaigns for an advertiser as per the solution id", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/campaigns", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "solutionId", "value": "", "type": "query", "description": "the solution id" }, { "name": "startDate", "value": "2023-06-08", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "2023-06-14", "type": "query", "description": "the end date" } ] }, "docs": "Get campaigns for an advertiser as per the solution id" }, { "info": { "name": "Get audiences for an advertiser as per the solution id", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/audiences", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "solutionId", "value": "", "type": "query", "description": "the solution id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "campaignIds", "value": "", "type": "query", "description": "the comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated AdReady Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "", "type": "query", "description": "the end date" } ] }, "docs": "Fetch audiences for an advertiser as per the solution id" } ] }, { "info": { "name": "version-controller", "type": "folder" }, "items": [ { "info": { "name": "getVersion", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/version" } }, { "info": { "name": "getVersion_1", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/version" } }, { "info": { "name": "throwException", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/throw_exception" } } ] }, { "info": { "name": "health-check", "type": "folder" }, "items": [ { "info": { "name": "getHealthCheckPage", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/health-check" } } ] }, { "info": { "name": "vendor-master-controller", "type": "folder" }, "items": [ { "info": { "name": "getAllVendor", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/vendors", "params": [ { "name": "productCategoryId", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "token-controller", "type": "folder" }, "items": [ { "info": { "name": "generateThoughtSpotToken", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/token/thoughtSpot" } }, { "info": { "name": "tableauJwtToken", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/token/tableau" } }, { "info": { "name": "tableauJwtToken_1", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/token/tableau/:advertiserId", "params": [ { "name": "advertiserId", "value": "", "type": "path" } ] } }, { "info": { "name": "tableauSignInTokenByAdvertiser", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/token/tableau/sign/:advertiserId", "params": [ { "name": "advertiserId", "value": "", "type": "path" } ] } }, { "info": { "name": "tableauJwtTokenByAccount", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/token/tableau/account/:accountId", "params": [ { "name": "accountId", "value": "", "type": "path" } ] } }, { "info": { "name": "refreshToken", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/token/refresh" } }, { "info": { "name": "parseJwtToken", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/token/parse" } }, { "info": { "name": "removeJwtToken", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/token/remove" } } ] }, { "info": { "name": "config-controller", "type": "folder" }, "items": [ { "info": { "name": "getTheme", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/theme", "params": [ { "name": "domain", "value": "", "type": "query" }, { "name": "appId", "value": "", "type": "query" }, { "name": "mode", "value": "", "type": "query" } ] } }, { "info": { "name": "getSecuredConfig", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/secured_config" } }, { "info": { "name": "getConfig", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/config", "params": [ { "name": "domain", "value": "", "type": "query" }, { "name": "appId", "value": "", "type": "query" }, { "name": "mode", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "errors-controller", "type": "folder" }, "items": [ { "info": { "name": "throwErr", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/test/error" } } ] }, { "info": { "name": "tableau-controller", "type": "folder" }, "items": [ { "info": { "name": "Download Tableau report", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/tableau/:advertiserId/download/views/:viewId/:type", "params": [ { "name": "advertiserId", "value": "123", "type": "path", "description": "Advertiser ID" }, { "name": "viewId", "value": "my-dashboard-id", "type": "path", "description": "View ID" }, { "name": "type", "value": "pdf", "type": "path", "description": "Report type (e.g., pdf, png)" } ] }, "docs": "Downloads a Tableau report for the given advertiser, view, and type" }, { "info": { "name": "tableauViews", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/tableau/views/:advertiserId", "params": [ { "name": "advertiserId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "Tableau Views", "type": "folder" }, "items": [ { "info": { "name": "Get Tableau views for an account", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/tableau/views/account/:accountId", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The account ID" } ] }, "docs": "Retrieve a list of Tableau views belonging to a specific account ID" } ] }, { "info": { "name": "line-item-history-controller", "type": "folder" }, "items": [ { "info": { "name": "findByLineItemId", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/lineItemHistory/lineitem/:lineItemId", "params": [ { "name": "lineItemId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "available-features-controller", "type": "folder" }, "items": [ { "info": { "name": "getAvailableFeatures", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/features" } } ] }, { "info": { "name": "dmm-controller", "type": "folder" }, "items": [ { "info": { "name": "getIoMarketFeedRawByCampaignIdAndPackageId", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/dmm/campaign/:campaignId/package/:packageId/ioMarketFeedRaw", "params": [ { "name": "campaignId", "value": "", "type": "path" }, { "name": "packageId", "value": "", "type": "path" } ] }, "docs": "getIoMarketFeedRawByCampaignIdAndPackageId" }, { "info": { "name": "getIoMarketFeedRawHistoryByCampaignIdAndPackageId", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/dmm/campaign/:campaignId/package/:packageId/ioMarketFeedRawHistory", "params": [ { "name": "campaignId", "value": "", "type": "path" }, { "name": "packageId", "value": "", "type": "path" } ] }, "docs": "getIoMarketFeedRawHistoryByCampaignIdAndPackageId" }, { "info": { "name": "getMarketGroupsFeedRawByCampaignId", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/dmm/campaign/:campaignId/marketGroupsFeedRaw", "params": [ { "name": "campaignId", "value": "", "type": "path" } ] }, "docs": "getMarketGroupsFeedRawByCampaignId" }, { "info": { "name": "getMarketGroupsFeedRawHistoryByCampaignId", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/dmm/campaign/:campaignId/marketGroupsFeedRawHistory", "params": [ { "name": "campaignId", "value": "", "type": "path" } ] }, "docs": "getMarketGroupsFeedRawHistoryByCampaignId" }, { "info": { "name": "getIoSiteListFeedRawByCampaignId", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/dmm/campaign/:campaignId/ioSiteListFeedRaw", "params": [ { "name": "campaignId", "value": "", "type": "path" } ] }, "docs": "getIoSiteListFeedRawByCampaignId" }, { "info": { "name": "getIoSiteListFeedRawHistoryByCampaignId", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/dmm/campaign/:campaignId/ioSiteListFeedRawHistory", "params": [ { "name": "campaignId", "value": "", "type": "path" } ] }, "docs": "getIoSiteListFeedRawHistoryByCampaignId" }, { "info": { "name": "getIoKeywordListFeedRawByCampaignId", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/dmm/campaign/:campaignId/ioKeywordListFeedRaw", "params": [ { "name": "campaignId", "value": "", "type": "path" } ] }, "docs": "getIoKeywordListFeedRawByCampaignId" }, { "info": { "name": "getIoKeywordListFeedRawHistoryByCampaignId", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/dmm/campaign/:campaignId/ioKeywordListFeedRawHistory", "params": [ { "name": "campaignId", "value": "", "type": "path" } ] }, "docs": "getIoKeywordListFeedRawHistoryByCampaignId" }, { "info": { "name": "getIoAudienceDefinitionFeedRawByCampaignId", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/dmm/campaign/:campaignId/ioAudienceDefinitionFeedRaw", "params": [ { "name": "campaignId", "value": "", "type": "path" } ] }, "docs": "getIoAudienceDefinitionFeedRawByCampaignId" }, { "info": { "name": "getIoAudienceDefinitionFeedRawHistoryByCampaignId", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/dmm/campaign/:campaignId/ioAudienceDefinitionFeedRawHistory", "params": [ { "name": "campaignId", "value": "", "type": "path" } ] }, "docs": "getIoAudienceDefinitionFeedRawHistoryByCampaignId" }, { "info": { "name": "getPlacements", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/dmm/placement", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPlacements_1", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/dmm/placement", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPlacements_2", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/dmm/placement", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPlacements_4", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.digitalremedy.com/api/dmm/placement", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPlacements_3", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/dmm/placement", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPlacements_5", "type": "http" }, "http": { "method": "HEAD", "url": "https://platform.digitalremedy.com/api/dmm/placement", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPlacements_6", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://platform.digitalremedy.com/api/dmm/placement", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPlacementsHistory", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/dmm/placementHistory", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPlacementsHistory_1", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/dmm/placementHistory", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPlacementsHistory_2", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/dmm/placementHistory", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPlacementsHistory_4", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.digitalremedy.com/api/dmm/placementHistory", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPlacementsHistory_3", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/dmm/placementHistory", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPlacementsHistory_5", "type": "http" }, "http": { "method": "HEAD", "url": "https://platform.digitalremedy.com/api/dmm/placementHistory", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPlacementsHistory_6", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://platform.digitalremedy.com/api/dmm/placementHistory", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPackages", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/dmm/package", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPackages_1", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/dmm/package", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPackages_2", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/dmm/package", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPackages_4", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.digitalremedy.com/api/dmm/package", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPackages_3", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/dmm/package", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPackages_5", "type": "http" }, "http": { "method": "HEAD", "url": "https://platform.digitalremedy.com/api/dmm/package", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPackages_6", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://platform.digitalremedy.com/api/dmm/package", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPackagesHistory", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/dmm/packageHistory", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPackagesHistory_1", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/dmm/packageHistory", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPackagesHistory_2", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/dmm/packageHistory", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPackagesHistory_4", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.digitalremedy.com/api/dmm/packageHistory", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPackagesHistory_3", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/dmm/packageHistory", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPackagesHistory_5", "type": "http" }, "http": { "method": "HEAD", "url": "https://platform.digitalremedy.com/api/dmm/packageHistory", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getPackagesHistory_6", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://platform.digitalremedy.com/api/dmm/packageHistory", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getCampaigns", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/dmm/campaign", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getCampaigns_1", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/dmm/campaign", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getCampaigns_2", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/dmm/campaign", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getCampaigns_4", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.digitalremedy.com/api/dmm/campaign", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getCampaigns_3", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/dmm/campaign", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getCampaigns_5", "type": "http" }, "http": { "method": "HEAD", "url": "https://platform.digitalremedy.com/api/dmm/campaign", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getCampaigns_6", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://platform.digitalremedy.com/api/dmm/campaign", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getCampaignsHistory", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/dmm/campaignHistory", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getCampaignsHistory_1", "type": "http" }, "http": { "method": "POST", "url": "https://platform.digitalremedy.com/api/dmm/campaignHistory", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getCampaignsHistory_2", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.digitalremedy.com/api/dmm/campaignHistory", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getCampaignsHistory_4", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.digitalremedy.com/api/dmm/campaignHistory", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getCampaignsHistory_3", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.digitalremedy.com/api/dmm/campaignHistory", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getCampaignsHistory_5", "type": "http" }, "http": { "method": "HEAD", "url": "https://platform.digitalremedy.com/api/dmm/campaignHistory", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } }, { "info": { "name": "getCampaignsHistory_6", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://platform.digitalremedy.com/api/dmm/campaignHistory", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" }, { "name": "sortKey", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "device-type-controller", "type": "folder" }, "items": [ { "info": { "name": "getDeviceTypeMaster", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/deviceTypes", "params": [ { "name": "productCategoryId", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "demo-advertiser-mapping-controller", "type": "folder" }, "items": [ { "info": { "name": "getDemoAdvertiserMappings", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/demoAdvtMapping" } } ] }, { "info": { "name": "deal-performance-controller", "type": "folder" }, "items": [ { "info": { "name": "list_4", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/deals" } }, { "info": { "name": "get_9", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/deals/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "Social Solution", "type": "folder" }, "items": [ { "info": { "name": "Get dimension-wise top performing metrics for Social solution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/social/top_performers", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "solutionId", "value": "", "type": "path", "description": "the solution id" }, { "name": "dimension", "value": "", "type": "query", "description": "the dimension by which data to be grouped, either campaign, adSet, ad, placement" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "creatives", "value": "", "type": "query", "description": "the comma-separated creative ids to filter" }, { "name": "campaignIds", "value": "", "type": "query", "description": "the comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated AdReady Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "2023-06-08", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "2023-06-14", "type": "query", "description": "the end date" } ] }, "docs": "Get dimension-wise top performing metrics for Social solution" }, { "info": { "name": "Get dimension-wise metrics for Social solution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/social/metrics/distribution", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "solutionId", "value": "", "type": "path", "description": "the solution id" }, { "name": "metric", "value": "", "type": "query", "description": "the metric to be returned, either ctr, cpc, vcr, cpcv, cpa, roas" }, { "name": "dimension", "value": "", "type": "query", "description": "the dimension by which data to be grouped, either campaign, adSet, ad, placement" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "creatives", "value": "", "type": "query", "description": "the comma-separated creative ids to filter" }, { "name": "pixelIds", "value": "", "type": "query", "description": "the comma-separated pixel ids to filter" }, { "name": "campaignIds", "value": "", "type": "query", "description": "the comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated AdReady Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "2023-06-08", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "2023-06-14", "type": "query", "description": "the end date" } ] }, "docs": "Get dimension-wise metrics for Social solution" }, { "info": { "name": "Get daily metrics for Social solution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/social/metrics/daily", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "solutionId", "value": "", "type": "path", "description": "the solution id" }, { "name": "metric", "value": "", "type": "query", "description": "the metric like ctr / vcr / cpa / roas" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "creatives", "value": "", "type": "query", "description": "the comma-separated creative ids to filter" }, { "name": "pixelIds", "value": "", "type": "query", "description": "the comma-separated pixel ids to filter" }, { "name": "campaignIds", "value": "", "type": "query", "description": "the comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated AdReady Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "2023-06-08", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "2023-06-14", "type": "query", "description": "the end date" }, { "name": "compareStartDate", "value": "2023-06-01", "type": "query", "description": "the compare start date" }, { "name": "compareEndDate", "value": "2023-06-07", "type": "query", "description": "the compare end date" } ] }, "docs": "Get daily metrics for Social solution" }, { "info": { "name": "Get dimension-wise measurements for Social solution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/social/measurements/distribution", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "solutionId", "value": "", "type": "path", "description": "the solution id" }, { "name": "measurement", "value": "", "type": "query" }, { "name": "dimension", "value": "", "type": "query", "description": "the dimension by which data to be grouped, either campaign, adSet, ad, placement" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "creatives", "value": "", "type": "query", "description": "the comma-separated creative ids to filter" }, { "name": "pixelIds", "value": "", "type": "query", "description": "the comma-separated pixel ids to filter" }, { "name": "campaignIds", "value": "", "type": "query", "description": "the comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated AdReady Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "2023-06-08", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "2023-06-14", "type": "query", "description": "the end date" } ] }, "docs": "Get dimension-wise measurements for Social solution" }, { "info": { "name": "Get daily measurements for Social solution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/social/measurements/daily", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "solutionId", "value": "", "type": "path", "description": "the solution id" }, { "name": "measurement", "value": "", "type": "query", "description": "the measurement to be returned, either Impressions / Spend / Clicks / Video Completions / Conversions / Revenue" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "creatives", "value": "", "type": "query", "description": "the comma-separated creative ids to filter" }, { "name": "pixelIds", "value": "", "type": "query", "description": "the comma-separated pixel ids to filter" }, { "name": "campaignIds", "value": "", "type": "query", "description": "the comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated AdReady Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "2023-06-08", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "2023-06-14", "type": "query", "description": "the end date" }, { "name": "compareStartDate", "value": "2023-06-01", "type": "query", "description": "the compare start date" }, { "name": "compareEndDate", "value": "2023-06-07", "type": "query", "description": "the compare end date" } ] }, "docs": "Get daily measurements for Social solution" } ] }, { "info": { "name": "App Console: Social", "type": "folder" }, "items": [ { "info": { "name": "Get summary for Social solution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/social/summary", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "solutionId", "value": "", "type": "path", "description": "the solution id" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "creatives", "value": "", "type": "query", "description": "the comma-separated creative ids to filter" }, { "name": "pixelIds", "value": "", "type": "query", "description": "the comma-separated pixel ids to filter" }, { "name": "campaignIds", "value": "", "type": "query", "description": "the comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated AdReady Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "2023-06-08", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "2023-06-14", "type": "query", "description": "the end date" }, { "name": "compareStartDate", "value": "2023-06-01", "type": "query", "description": "the compare start date" }, { "name": "compareEndDate", "value": "2023-06-07", "type": "query", "description": "the compare end date" } ] }, "docs": "Get summary for Social solution" }, { "info": { "name": "Get dimension-wise measurements & metrics report for Social solution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/social/reports", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "solutionId", "value": "", "type": "path", "description": "the solution id" }, { "name": "dimension", "value": "", "type": "query", "description": "the dimension by which data to be grouped, either overall, day, campaign, adSet, ad, placement" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "creatives", "value": "", "type": "query", "description": "the comma-separated creative ids to filter" }, { "name": "campaignIds", "value": "", "type": "query", "description": "the comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated AdReady Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "2023-06-08", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "2023-06-14", "type": "query", "description": "the end date" } ] }, "docs": "Get dimension-wise measurements & metrics report for Social solution" }, { "info": { "name": "Get dimension-wise measurements & metrics for Social solution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/social/performance", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "the advertiser id" }, { "name": "solutionId", "value": "", "type": "path", "description": "the solution id" }, { "name": "dimension", "value": "", "type": "query", "description": "the dimension by which data to be grouped, either campaign, adSet, ad, placement" }, { "name": "client", "value": "", "type": "query", "description": "the account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "the advertiser name" }, { "name": "creatives", "value": "", "type": "query", "description": "the comma-separated creative ids to filter" }, { "name": "campaignIds", "value": "", "type": "query", "description": "the comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "the comma-separated AdReady Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "2023-06-08", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "2023-06-14", "type": "query", "description": "the end date" } ] }, "docs": "Get dimension-wise measurements & metrics for Social solution" } ] }, { "info": { "name": "App Console: Search", "type": "folder" }, "items": [ { "info": { "name": "Get dimension-wise top performing metrics for Search solution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/search/top_performers", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser id" }, { "name": "solutionId", "value": "", "type": "path", "description": "The solution id" }, { "name": "dimension", "value": "", "type": "query", "description": "The dimensions (comma-separated) by which data is grouped: campaign, adgroup, country, state, dma, zipcode, county, city, ad, adType, keyword, matchType" }, { "name": "client", "value": "", "type": "query", "description": "The account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "The advertiser name" }, { "name": "keywords", "value": "", "type": "query", "description": "Comma-separated keywords to filter" }, { "name": "creatives", "value": "", "type": "query", "description": "Comma-separated creative ids to filter" }, { "name": "campaignIds", "value": "", "type": "query", "description": "Comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "Comma-separated AdReady Id & start date (separated by |) combinations" }, { "name": "startDate", "value": "2023-06-08", "type": "query", "description": "The start date" }, { "name": "endDate", "value": "2023-06-14", "type": "query", "description": "The end date" } ] }, "docs": "Get dimension-wise top performing metrics for Search solution" }, { "info": { "name": "Get summary for Search solution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/search/summary", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser id" }, { "name": "solutionId", "value": "", "type": "path", "description": "The solution id" }, { "name": "client", "value": "", "type": "query", "description": "The account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "The advertiser name" }, { "name": "keywords", "value": "", "type": "query", "description": "The keywords to filter (comma-separated)" }, { "name": "creatives", "value": "", "type": "query", "description": "Comma-separated creative ids to filter" }, { "name": "campaignIds", "value": "", "type": "query", "description": "Comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "Comma-separated AdReady Id & start date (separated by |) combinations to filter" }, { "name": "startDate", "value": "2023-06-08", "type": "query", "description": "The start date" }, { "name": "endDate", "value": "2023-06-14", "type": "query", "description": "The end date" }, { "name": "compareStartDate", "value": "2023-06-01", "type": "query", "description": "The compare start date" }, { "name": "compareEndDate", "value": "2023-06-07", "type": "query", "description": "The compare end date" } ] }, "docs": "Get summary for Search solution" }, { "info": { "name": "Get dimension-wise measurements & metrics report for Search solution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/search/reports", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser id" }, { "name": "solutionId", "value": "", "type": "path", "description": "The solution id" }, { "name": "dimension", "value": "", "type": "query", "description": "The dimension by which data to be grouped: overall, day, campaign, adgroup, country, state, dma, zipcode, county, city, ad, adType, keyword, matchType" }, { "name": "client", "value": "", "type": "query", "description": "The account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "The advertiser name" }, { "name": "keywords", "value": "", "type": "query", "description": "The keywords to filter (comma-separated)" }, { "name": "creatives", "value": "", "type": "query", "description": "Comma-separated creative ids to filter" }, { "name": "campaignIds", "value": "", "type": "query", "description": "Comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "Comma-separated AdReady Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "2023-06-08", "type": "query", "description": "The start date" }, { "name": "endDate", "value": "2023-06-14", "type": "query", "description": "The end date" } ] }, "docs": "Get dimension-wise measurements & metrics report for Search solution" }, { "info": { "name": "Get dimension-wise measurements & metrics for Search solution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/search/performance", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser id" }, { "name": "solutionId", "value": "", "type": "path", "description": "The solution id" }, { "name": "dimension", "value": "", "type": "query", "description": "The dimension by which data to be grouped: campaign, adgroup, country, state, dma, zipcode, county, city, ad, adType, keyword, matchType" }, { "name": "client", "value": "", "type": "query", "description": "The account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "The advertiser name" }, { "name": "keywords", "value": "", "type": "query", "description": "The keywords to filter (comma-separated)" }, { "name": "creatives", "value": "", "type": "query", "description": "Comma-separated creative ids to filter" }, { "name": "campaignIds", "value": "", "type": "query", "description": "Comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "Comma-separated AdReady Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "2023-06-08", "type": "query", "description": "The start date" }, { "name": "endDate", "value": "2023-06-14", "type": "query", "description": "The end date" } ] }, "docs": "Get dimension-wise measurements & metrics for Search solution" }, { "info": { "name": "Get dimension-wise metrics for Search solution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/search/metrics/distribution", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser id" }, { "name": "solutionId", "value": "", "type": "path", "description": "The solution id" }, { "name": "metric", "value": "", "type": "query", "description": "The metric to be returned: ctr, cpc, cpa, roas" }, { "name": "dimension", "value": "", "type": "query", "description": "The dimension by which data is grouped: campaign, adgroup, country, state, dma, zipcode, county, city, ad, adType, keyword, matchType" }, { "name": "client", "value": "", "type": "query", "description": "The account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "The advertiser name" }, { "name": "keywords", "value": "", "type": "query", "description": "Comma-separated keywords to filter" }, { "name": "creatives", "value": "", "type": "query", "description": "Comma-separated creative ids to filter" }, { "name": "pixelIds", "value": "", "type": "query", "description": "Comma-separated pixel ids to filter" }, { "name": "campaignIds", "value": "", "type": "query", "description": "Comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "Comma-separated AdReady Id & start date (separated by |) combinations" }, { "name": "startDate", "value": "2023-06-08", "type": "query", "description": "The start date" }, { "name": "endDate", "value": "2023-06-14", "type": "query", "description": "The end date" } ] }, "docs": "Get dimension-wise metrics for Search solution" }, { "info": { "name": "Get daily metrics for Search solution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/search/metrics/daily", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser id" }, { "name": "solutionId", "value": "", "type": "path", "description": "The solution id" }, { "name": "metric", "value": "", "type": "query", "description": "The metric like ctr / cpc / cpa / roas" }, { "name": "client", "value": "", "type": "query", "description": "The account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "The advertiser name" }, { "name": "keywords", "value": "", "type": "query", "description": "Comma-separated keywords to filter" }, { "name": "creatives", "value": "", "type": "query", "description": "Comma-separated creative ids to filter" }, { "name": "pixelIds", "value": "", "type": "query", "description": "Comma-separated pixel ids to filter" }, { "name": "campaignIds", "value": "", "type": "query", "description": "Comma-separated campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "Comma-separated AdReady Id & start date (separated by |) combinations" }, { "name": "startDate", "value": "2023-06-08", "type": "query", "description": "The start date" }, { "name": "endDate", "value": "2023-06-14", "type": "query", "description": "The end date" }, { "name": "compareStartDate", "value": "2023-06-01", "type": "query", "description": "The compare start date" }, { "name": "compareEndDate", "value": "2023-06-07", "type": "query", "description": "The compare end date" } ] }, "docs": "Get daily metrics for Search solution" }, { "info": { "name": "Get dimension-wise measurements for Search solution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/search/measurements/distribution", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser id" }, { "name": "solutionId", "value": "", "type": "path", "description": "The solution id" }, { "name": "measurement", "value": "", "type": "query", "description": "The measurement to be returned: impressions / spend / clicks / conversions / revenue" }, { "name": "dimension", "value": "", "type": "query", "description": "The dimension by which data is grouped: campaign, adgroup, country, state, dma, zipcode, county, city, ad, adType, keyword, matchType" }, { "name": "client", "value": "", "type": "query", "description": "The account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "The advertiser name" }, { "name": "keywords", "value": "", "type": "query", "description": "The keywords to filter (comma-separated)" }, { "name": "creatives", "value": "", "type": "query", "description": "Comma-separated creative ids to filter" }, { "name": "pixelIds", "value": "", "type": "query", "description": "Comma-separated pixel ids to filter" }, { "name": "campaignIds", "value": "", "type": "query", "description": "Comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "Comma-separated AdReady Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "2023-06-08", "type": "query", "description": "The start date" }, { "name": "endDate", "value": "2023-06-14", "type": "query", "description": "The end date" } ] }, "docs": "Get dimension-wise measurements for Search solution" }, { "info": { "name": "Get daily measurements for Search solution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/search/measurements/daily", "params": [ { "name": "advertiserId", "value": "", "type": "path", "description": "The advertiser id" }, { "name": "solutionId", "value": "", "type": "path", "description": "The solution id" }, { "name": "measurement", "value": "", "type": "query", "description": "The measurement to be returned: impressions / spend / clicks / conversions / revenue" }, { "name": "client", "value": "", "type": "query", "description": "The account/client name" }, { "name": "advertiser", "value": "", "type": "query", "description": "The advertiser name" }, { "name": "keywords", "value": "", "type": "query", "description": "Comma-separated keywords to filter" }, { "name": "creatives", "value": "", "type": "query", "description": "Comma-separated creative ids to filter" }, { "name": "pixelIds", "value": "", "type": "query", "description": "Comma-separated pixel ids to filter" }, { "name": "campaignIds", "value": "", "type": "query", "description": "Comma-separated Campaign ids to filter" }, { "name": "adGroups", "value": "", "type": "query", "description": "Comma-separated AdReady Id & start date (separated by |) combination to filter" }, { "name": "startDate", "value": "2023-06-08", "type": "query", "description": "The start date" }, { "name": "endDate", "value": "2023-06-14", "type": "query", "description": "The end date" }, { "name": "compareStartDate", "value": "2023-06-01", "type": "query", "description": "The compare start date" }, { "name": "compareEndDate", "value": "2023-06-07", "type": "query", "description": "The compare end date" } ] }, "docs": "Get daily measurements for Search solution" } ] }, { "info": { "name": "App Console: Converged TV", "type": "folder" }, "items": [ { "info": { "name": "Get something for Social solution", "type": "http" }, "http": { "method": "GET", "url": "https://platform.digitalremedy.com/api/ac/advertisers/:advertiserId/solutions/:solutionId/convergedtv/summary", "params": [ { "name": "solutionId", "value": "7", "type": "path", "description": "the solution id" }, { "name": "advertiserId", "value": "674", "type": "path", "description": "the advertiser id" }, { "name": "advertiser", "value": "Jersey Mike's Subs", "type": "query", "description": "the advertiser name" }, { "name": "client", "value": "Jersey Mike's Subs", "type": "query", "description": "the account/client name" }, { "name": "campaignIds", "value": "", "type": "query", "description": "the CSV Campaign ids to filter on" }, { "name": "adGroups", "value": "", "type": "query", "description": "the CSV AdReady Ids to filter on" }, { "name": "startDate", "value": "2024-01-01", "type": "query", "description": "the start date" }, { "name": "endDate", "value": "2024-04-15", "type": "query", "description": "the end date" }, { "name": "conversionWindow", "value": "", "type": "query", "description": "the conversion window in hours" } ] }, "docs": "Get something for Social solution" } ] } ], "bundled": true }