OBLYTECH Logo
OBLYTECH Logo
ServiceNow REST and SOAP Integrations KPIs and Metrics That Matter

ServiceNow REST and SOAP Integrations KPIs and Metrics That Matter

REST and SOAP integration KPIs are the measures that show whether connections between ServiceNow and other systems are available, fast, accurate and complete. Each metric has a definition, a calculation, a data source, a common misuse and a review cadence, so each figure can be read in context.

Integration Uptime and Availability

Definition: How reliably are your REST and SOAP integrations available? Service level agreements (SLAs) typically target 99 to 99.9 availability, but measure actual performance.

Calculation: Measure integration endpoint availability: for each API call made, did it succeed and receive a response? Calculate uptime: successful calls divided by total calls attempted. Track separately by integration and by external system. Distinguish between ServiceNow outages (our fault) and external system outages (their fault).

Data Source: Integration logs, API monitoring tools, external system status pages if available.

Typical Misuse: Counting availability at the integration layer without checking data accuracy. An API that returns 200 OK but garbage data is not truly available. Monitor both success status and data correctness.

Review Cadence: Daily. Availability below target indicates configuration problems, external system issues, or authentication failures. Escalate immediately.

API Response Time and Latency

Definition: How fast do your integrations respond? Slow APIs impact user experience and process cycle times.

Calculation: Measure response time from request to response receipt. Track average, minimum, and maximum for each API. Identify baseline performance and alert when response times spike. Compare actual to contracted performance (SLA usually specifies max response time).

Data Source: Integration logs, API performance monitoring tools.

Typical Misuse: Assuming all slow responses are the same. A 10-second response might be acceptable for a background sync but unacceptable for a user-facing lookup. Set baselines per use case.

Review Cadence: Weekly. Response time creep (gradual slowdown) may indicate external system performance degradation or increased data volume. Investigate before it becomes a failure.

Data Accuracy and Synchronisation Correctness

Definition: When data flows through integrations, does it remain accurate and consistent?

Calculation: Sample integration results: pick random records synced and verify they match source. Compare source and target fields for a sample of records. Calculate accuracy: correct records divided by sample size. Track data mapping issues: are fields being transformed correctly?

Data Source: Integration logs, source system records, ServiceNow records after sync.

Typical Misuse: Assuming successful API call means data is correct. An API call might succeed but return stale data or data that failed transformation. Sample and verify actual data, not just API response codes.

Review Cadence: Weekly for critical integrations. Data accuracy issues may not be obvious until they cause business problems. Verify early.

Error Handling and Retry Success

Definition: When integration calls fail, are they automatically retried successfully or do they require manual intervention?

Calculation: Track failed API calls and categorise errors: transient (timeout, temporary connection failure, retry-able) versus permanent (authentication failure, invalid data, not retry-able). Measure retry success rate: how many initially-failed calls succeed on retry?

Data Source: Integration logs, retry logs.

Typical Misuse: Not distinguishing transient from permanent errors. Retrying a permanent error wastes resources. Design retry logic to handle transient errors only.

Review Cadence: Daily. High permanent-error counts indicate configuration or data problems needing immediate attention. Missing retry logic means integration is too fragile.

Data Completeness and Missing Field Detection

Definition: Are integrations receiving complete data from source systems or are required fields sometimes missing?

Calculation: For each integration, track which records are missing required fields. Calculate completeness: records with all required fields divided by total records. Identify which fields most frequently missing and from which source systems.

Data Source: Integration logs, validation rules in ServiceNow that flag missing fields.

Typical Misuse: Accepting incomplete data in the name of speed. Missing fields often indicate problems upstream (source system not populating required fields). Work with data owners to fix at the source.

Review Cadence: Weekly. Missing required fields block downstream processing and create rework. Investigate root cause and address.

Integration Volume and Throughput

Definition: How much data is flowing through your integrations? Volume trends indicate growing dependency and risk.

Calculation: Count records processed per day/week/month by each integration. Track growth rate. Identify which integrations carry high volume. Monitor whether peak volumes match capacity (are integrations keeping up during peak hours?).

Data Source: Integration logs, API call counters.

Typical Misuse: Not accounting for volume growth. An integration that handled 1,000 records daily when first built but now handles 10,000 may have different performance and reliability characteristics. Design for growth.

Review Cadence: Monthly. Volume growth may indicate new use cases or business expansion. Ensure integrations are scaled appropriately.

External System Dependency and Service Level

Definition: How dependent is your business on external systems accessed via REST and SOAP? What are their reliability characteristics?

Calculation: For each external system, identify business-critical integrations. Research and track that system’s uptime track record and published SLAs. Understand maintenance windows and planned downtime. Calculate business impact if integration fails.

Data Source: External system SLAs, status pages, maintenance calendars.

Typical Misuse: Not understanding your exposure. If a critical business process depends on an external system with poor reliability, that is risk. Build fallback processes or negotiate better SLAs.

Review Cadence: Quarterly. Revisit SLAs and dependencies. If new critical integrations are added, reassess business impact of outages.

API Security and Authentication Validation

Definition: Are integrations secure? Are credentials managed properly? Are API calls authenticated and encrypted?

Calculation: Audit integrations: do they use encrypted transport (HTTPS)? Are credentials stored securely (not hardcoded)? Are API tokens rotated regularly? Have expired credentials been removed?

Data Source: Integration configurations, security audit logs, credential management system.

Review Cadence: Quarterly security audit. Compromised credentials or unencrypted API calls create security and compliance risk.

Measure how quickly failures are noticed and fixed

Availability and response time say how an integration behaves on a normal day. They say much less about what happens when it breaks, and that is where most of the business cost sits. Two measures reveal the operating quality of an integration program more clearly than the usual health figures: how long it takes to notice that a flow has stopped delivering, and how long it takes to bring the flow back with its data intact. Both should be tracked per connection, because a single average hides the one connection that is always left to recover by hand.

Operational measures and what each one reveals

Measure What it reveals What it does not reveal
Time to detect a stopped flow Whether monitoring finds problems before users do Whether the detected problem was the right one to chase
Time to restore data after a failure Whether replay and reconciliation work in practice Whether the replayed records are correct
Failed items sitting in a queue or failure table Backlog growth and whether anyone owns the queue The cause of the failures
Duration of a scheduled integration job Slow growth in data volume or a dependency that is getting slower Whether the job finished with complete results
Failures grouped by endpoint and by error category Which remote service or credential is the common factor The business impact of each failure
Share of connections with a named owner and a current review Governance coverage across the register Whether the owners are doing the work

Set a baseline before you set a target

Targets set before a baseline exists are guesses, and teams soon learn to game guesses. Start by recording the current values for a fixed period. Look at how many failures occur in a normal week, how many of them recover without a person, and how long the slowest recovery takes. Then choose targets that the owner can defend against that baseline. A target that is merely aspirational will be ignored, and a target nobody can influence will be blamed for problems outside the team’s control.

An ordered way to introduce the measures

  1. Choose the few connections that carry the most business weight and start with those only.
  2. Record the current detection and recovery times from the incident history, even where the data is rough.
  3. Agree which failure categories count as the platform’s fault, the remote system’s fault, or a credential problem.
  4. Publish the measures to the owners in a form they can act on, with the raw records one click away.
  5. Review the measures at the governance cadence, and retire any measure that nobody has used to make a decision.

Measures that encourage the wrong behavior

A count of messages sent looks like productivity but rewards sending more, not sending correctly. A count of closed alerts rewards closing alerts without fixing their causes. Average response time can hide the slow tail that causes timeouts for users. Where a measure can be improved by changing how it is recorded rather than how the integration works, it should be dropped or paired with a second measure that exposes the gaming.

Questions about integration metrics

Why track time to detect when we already have alerts?

An alert that fires is not the same as an alert that reaches someone able to act. Time to detect measures the gap between the failure starting and a responsible person knowing about it, which is what the business feels.

Should failed items count as a metric or only as a list?

Both. The count shows whether the backlog is growing, and the list is what the owner works through. A rising count with a flat list usually means the list is not being reviewed.

How often should these measures be reviewed?

Operational measures fit a short cycle because they guide daily work, while coverage measures such as owner assignment fit the governance review. Mixing the two in one report hides the signals that need action.

Agree the measures with the people who act on them

Measures are only useful when the people who act on them agree what each one means. Access measures sit with the security and access design guide, and a separate monitoring piece says who responds to each signal. For reporting on the platform itself, see the note on enhancing ServiceNow reporting, and the explainer on the event registry describes one source of event data.

Frequently asked questions

Should we retry all failed API calls?

No. Retry transient failures (timeout, connection error, 503 Service Unavailable). Do not retry permanent failures (400 Bad Request, 401 Unauthorized, invalid data). Retrying permanent errors wastes resources and delays proper error handling.

What response time is acceptable for REST APIs?

Depends on use case. User-facing lookups should respond quickly. Background data syncs can tolerate longer waits. Batch processes can tolerate longer still. Set targets per use case and monitor against them.

How do we ensure data consistency when integrations fail?

Use idempotent APIs when possible (same request called twice has same result). Log transaction IDs so you can reconcile. Build reconciliation processes that periodically verify data is consistent between systems. Handle duplicates gracefully.

Talk to Oblytech

Planning, running or fixing a ServiceNow programme? Tell us where you are and we will suggest a sensible next step.

Contact us