Use our JSON HTTPS API to export your organization’s reporting data.

Overview

Using our API, you can export the following reporting data for your organization:

• User Data
• Matching Data
• Session Data

Rate Limit

To avoid your key being revoked, you must send requests at the less frequent rate of:

• 1 request per minute
• 1 request at a time

Error Handling/Backoff

If receiving 429/500/502/503's you are expected to exponentially back off and try again later.

Request Specifications

Required Headers:

application/json

Authentication

Please email support@togetherplatform.com & CC integrations@togetherplatform.com to request your credentials. 

Note: credentials are only available for Professional (optional) and Enterprise plans. 

Once our team has confirmed that your credentials have been issued, you will be able to find them on your Integrations page near the bottom under API Keys:

We strongly recommend using a secrets manager. Plain text files like dotenv lead to accidental costly leaks. Use Doppler for a developer-friendly experience. AWS and Google Cloud have native solutions as well.

Export User Data

Request:

GET https://api.togetherplatform.com/public/{organizationId}/reports/export/userReport

Where organizationId is the ID as supplied by Together

Response:

{

“report”: string

}

The report string in the response can be parsed into a CSV file.

Export Matching Data

Request:

GET https://api.togetherplatform.com/public/{organizationId}/reports/export/pairingReport

Where organizationId is the ID as supplied by Together

Response:

{

“report”: string

}

The report string in the response can be parsed into a CSV file.

Export Session Data

Request:

GET https://api.togetherplatform.com/public/{organizationId}/reports/export/sessionReport

Where organizationId is the ID as supplied by Together

Response:

{

“report”: string

}

The report string in the response can be parsed into a CSV file.

Responses

*For 429/500/502/503 please back-off and try again later.