Reports API

Article author
Samar Sanghera
  • Updated

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
  • Pairing 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:

Header Name

Header value

organization-id

As supplied by Together

client-id

As supplied by Together

api-key

As supplied by Together

content-type

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:

api_keys.png

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 Pairing 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

Response Code

Description

200 - OK

User fields were updated

400 - Bad Request

Missing required information, see response body

401 - Unauthenticated

Please attach valid authentication credentials

*429 - Too many requests

Slow down your request rate

*500/502/503

Temporary service outage

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

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.