Reporting API Overview

Social Sync’s Reporting API lets you automatically pull reporting data into your CRM or other systems, removing the need to manually export and upload reports.

Once connected, your system can securely request data from Social Sync on a recurring basis. For example, your CRM could ask Social Sync for today’s donations and receive the relevant records automatically in a format it can process.

The Reporting API currently supports:

Your CRM or other system sends a request to Social Sync asking for a particular type of reporting data.

Social Sync checks that the request is authorised, retrieves the relevant records and returns the data as JSON, a standard format commonly used by APIs and software systems.

Requests can also be filtered so your integration only retrieves the information it needs rather than repeatedly pulling your full Social Sync dataset.

An API token is used to confirm that the system requesting your organisation’s data is authorised to access it.

You can generate an API token from your Social Sync account settings and provide it securely to the developer or technical team building your integration.

If a token is lost, compromised or no longer required, you can delete it and generate a replacement.

Each type of reporting data has its own API endpoint.

An endpoint is the address your CRM connects to when it wants to request a particular type of information.

Social Sync currently provides separate endpoints for:

Transactions – Donation and transaction data.

Fundraisers – Fundraising page and fundraiser data.

Registrations – Campaign and event registration data.

For transaction and fundraiser requests, you can also filter by fundraising platform. Date filters can be used to request data for a particular period rather than retrieving everything each time.

All Reporting API endpoints return data as JSON.

Filters help your integration request only the records it needs.

Depending on the endpoint, requests can be filtered using options such as:

For example, an integration could request only JustGiving transactions created since its previous successful sync.

Using filters keeps requests more efficient and makes it easier to build recurring integrations that only retrieve new or relevant records.

Social Sync’s Reporting API documentation is provided through Swagger / OpenAPI.

This gives developers a technical reference showing:

Swagger also includes a Try it out feature, allowing developers to test API requests directly from the documentation before building them into another system.

See our Reporting API Technical Setup guide for information on generating a token, accessing the documentation and making your first request.

Generating an API token in Social Sync is straightforward, but connecting the Reporting API to your CRM will normally require someone with technical experience.

This is likely to be a developer, CRM specialist, integration partner or member of your IT team.

Social Sync provides the API, authentication and technical documentation, while your technical team is responsible for building and maintaining the connection to your own systems.

Does the Reporting API work with every CRM?

Any CRM or system capable of making authenticated API requests should be able to use the Social Sync Reporting API. The exact setup will depend on the capabilities of that system.

What technical skills do we need?

You will normally need someone comfortable working with APIs, authentication and JSON to build the connection between Social Sync and your CRM.

Can Social Sync build the CRM integration for us?

Social Sync provides the Reporting API, API tokens and technical documentation, but does not currently build bespoke CRM integrations on behalf of customers.

What data can we access through the API?

The Reporting API currently provides transaction, fundraiser and registration data, with a separate endpoint for each.