Edit

Web Service Telemetry

  • Article

All calls to Business Central web services are logged to partner telemetry. Telemetry enables you to monitor which endpoints are being used and the category of the web service, like SOAP, OData, or API. You can also see possible failures, which are tracked in the HTTP status codes for the calls.

Incoming web service telemetry

Web services telemetry gathers data about SOAP, OData, and API requests through the service. It provides information like the request's endpoint, time to complete, the SQL statements run, and more.

When calling Business Central web services, you can inject information about the caller into telemetry for REST API and OData calls.

  • Setting the HTTP header UserAgent logs requests with the httpHeaders dimension.

  • Setting the HTTP header client-request-id, logs requests with the httpHeaders dimension and it also sets the "OperationId"/ClientActivity in Application Insights.

This capability means you can use telemetry to see who's calling Business Central REST APIs and OData web services. It also lets you correlate to telemetry from other web services, if you use Azure Application Insights to instrument them.

For more information, go to Analyzing Incoming Web Services Request Telemetry.

Web service access key telemetry

The Business Central emits telemetry data about the success or failure of authenticating web service access keys on web service requests.

Important

Starting October, 2022, the use of access keys (Basic Auth) for web service authentication is deprecated and not supported in Business Central online. We recommend that you use OAuth2 instead. For more information, see Using OAuth to Authorize Business Central Web Services.

As a partner or customer, this data lets you monitor the use of web service access keys on your environments in preparation for the deprecation of the feature.

For more information, go to Analyzing Web Service Access Key Telemetry.

Web service publish failure telemetry

If a web service couldn't be published or a published web service isn't working, most often it's due to an error in creating metadata for the web service. All metadata creation failures along with stack trace of the element responsible for breaking web service metadata are available in partner telemetry.

For more information, go to Analyzing Web Service Publish Failure Telemetry.

See also

Web Services Overview
Web Services Best Practices
Analyzing Incoming Web Services Request Telemetry
Analyzing Web Service Access Key Telemetry
Configuring Business Central Server