Campaign Success Metrics

[Former Member]

Hi experts,

I have an urgent requirement. Need to create and publish OData API in Hybris Marketing Cloud which will enable a data lake system ( external system) to show in its dashboard Hybris Marketing Campaign Performance Metrics like : Email Sent, Open, Clicked, Bounced, CTR, Open Rate, Click to Open Rate , Bounce Rate etc. I have check the api.sap.com site for the Campaign based API but there are no APIs for campaign metrics with these parameters.

I want to know how such an Odata API can be created in YMKT Cloud which can be consumed by external system.

Regards,

Krish

[former_member226]

Hi Krish,

let me answers all points mentioned above in point by point manner:

• As soon as you publish the CDS view, technically a new SICF node is generated in back-end or in simple terms a new odata service URL is generated with the endpoints of your custom CDS view exposed to https, which can be called by any external system provided a valid authentication parameters are passed.For your testing purpose you can even use Postman (Only after communication arrangement is created) with the INBOUND user configured in communication arrangement.
• For CDS if it is just the 2 views which i mentioned it could even be done in 2 to 3 hours but if new complexities are involved then its tough to predict the time taken for development. So in short standard solution should not take more than half a day at marketing side but if new key figure or restrictions are included then it can increase accordingly.
• When I Say Inbound API, It means Inbound to Marketing, which will be triggered by Postman or Datalake system. For security reasons SAP provided us the concept of communication arrangement which enable the APIs to be consumed by external SAP or non-sap system. So once the API in configured using custom communication scenario and arrangement then it means you are exposing you data to external world via https protocol and any one with the inbound credentials of Communication arrangement will be able to pull the data from SAP Marketing Cloud.

Hope it clarifies all your points!

Thanks
Saurabh

[Former Member]

Hi Saurabh,

I noted in your response , the following point:

Once done navigate to "Custom Communication Scenario" and add the newly published inbound API from step 5 to this and publish it.

My requirement is not an inbound API into Hybris Marketing but an API generated by Hybris Marketing which can be called and consumed by external system ( an Outbound API). Hope I have made my requirement clear.

Please let me know if it is possible to do this for campaign metrics through the Custom CDS View, you have mentioned in your response or are there any other approaches?

Thanking you very much.

Regards,

Krish

[former_member226]

Hi Krish,

let me answers all points mentioned above in point by point manner:

• As soon as you publish the CDS view, technically a new SICF node is generated in back-end or in simple terms a new odata service URL is generated with the endpoints of your custom CDS view exposed to https, which can be called by any external system provided a valid authentication parameters are passed.For your testing purpose you can even use Postman (Only after communication arrangement is created) with the INBOUND user configured in communication arrangement.
• For CDS if it is just the 2 views which i mentioned it could even be done in 2 to 3 hours but if new complexities are involved then its tough to predict the time taken for development. So in short standard solution should not take more than half a day at marketing side but if new key figure or restrictions are included then it can increase accordingly.
• When I Say Inbound API, It means Inbound to Marketing, which will be triggered by Postman or Datalake system. For security reasons SAP provided us the concept of communication arrangement which enable the APIs to be consumed by external SAP or non-sap system. So once the API in configured using custom communication scenario and arrangement then it means you are exposing you data to external world via https protocol and any one with the inbound credentials of Communication arrangement will be able to pull the data from SAP Marketing Cloud.

Hope it clarifies all your points!

Thanks
Saurabh

[Former Member]

Hi Saurabh,

Thanking you very much. Your solution and approach helped me intensely. In fact, I have been able to communicate this as solution to the team.

Have a related question here - After creating the API by following the above steps, are there any additional steps required. Is it enough to publish the API( will it be an URI) or is the generated API to be registered in a middleware - like CPI ( HCI). The main requirement is the external system should be able to call the API ( directly or through MWare) and get the campaign metrics displayed.

How much time of development work is needed to create and register the CDS view?

Please revert asap..

Regards,

krish

[former_member226]

Hi Krish,

It is possible to expose the campaign success data in marketing cloud to external world via APis. You can do as follow:

1. Navigate to "Custom CDS Views" app in your Marketing Cloud Solution.Create a new CDS View.

2. Fill in the details, Make sure "External API" checkbox is marked as TRUE.

3. Add primary data source and secondary data source as "I_Mkt_Initiative" as well as "I_MKT_AggrdCmpgnSpndSuccCube" respectively and make the property association as follow:

4. Go back to your CDS view and now follow the guided path to enable the field section, change the properties, add any calculated field etc.

5. Save and publish your changes. This will automatically create a odata api for your view in SMC. Note: It may take upto 5 mins after the publishing action, to appear API in custom communication scenario.

6. Once done navigate to "Custom Communication Scenario" and add the newly published inbound API from step 5 to this and publish it.

7. Create a new communication arrangement for scenario created in step 6. Note down the user ID and password for inbound communication.

That's it...You are now ready to test the API using nay rest client like Postman etc.

Thanks

Saurabh