API حوالہ
client-reports
اس حصے میں 34 اینڈ پوائنٹس ہیں۔ ہر ایک کا اپنا صفحہ ہے جس میں اس کے پیرامیٹرز، اس کا جواب اور ایک درخواست ہے جسے آپ چلا سکتے ہیں۔
| طریقہ | راستہ | یہ کیا کرتا ہے | اجازت |
|---|---|---|---|
| GET | /v1/client-reports/brands | Your report looks (white-label brands). | sites.view |
| POST | /v1/client-reports/brands | Add a report look — your name, colours, intro and footer. | sites.create |
| DELETE | /v1/client-reports/brands/{brand_id} | Remove a report look. | sites.create |
| PATCH | /v1/client-reports/brands/{brand_id} | Change a report look. | sites.create |
| DELETE | /v1/client-reports/brands/{brand_id}/logo | Take the logo off future reports. | sites.create |
| POST | /v1/client-reports/brands/{brand_id}/logo | Upload the logo a report look carries. | sites.create |
| POST | /v1/client-reports/brands/{brand_id}/reply-to/code | E-mail a confirmation code to the look's reply-to address. | sites.create |
| POST | /v1/client-reports/brands/{brand_id}/reply-to/confirm | Confirm the reply-to address with the code it received. | sites.create |
| GET | /v1/client-reports/clients | The clients you make reports for, with their schedules. | sites.view |
| POST | /v1/client-reports/clients | Add a client, the domains a report covers, who receives it and how often. | sites.create |
| DELETE | /v1/client-reports/clients/{client_id} | Remove a client and its reports. | sites.create |
| PATCH | /v1/client-reports/clients/{client_id} | Change a client or its schedule. | sites.create |
| DELETE | /v1/client-reports/clients/{client_id}/logo | Remove the client's logo from future reports. | sites.create |
| POST | /v1/client-reports/clients/{client_id}/logo | Upload the client's own logo, printed beside "Prepared for" on its reports. | sites.create |
| GET | /v1/client-reports/clients/{client_id}/portal-links | The client's own page links, newest first. | sites.view |
| POST | /v1/client-reports/clients/{client_id}/portal-links | Make a link to the client's own page of reports, under the agency's brand. | sites.create |
| DELETE | /v1/client-reports/clients/{client_id}/portal-links/{link_id} | End a client page link now. | sites.create |
| POST | /v1/client-reports/clients/{client_id}/reports | Make a report for this client now. | sites.create |
| GET | /v1/client-reports/overview | What your Client Reports plan allows, and which report sections have data. | sites.view |
| GET | /v1/client-reports/reports | Reports made, newest first (100 at most). | sites.view |
| GET | /v1/client-reports/reports/{report_id} | One report's state, headline figures and share link. | sites.view |
| GET | /v1/client-reports/reports/{report_id}/pdf | Download the report as a PDF. | sites.view |
| GET | /v1/client-reports/reports/{report_id}/preview | The report as the HTML page its PDF is made from. | sites.view |
| POST | /v1/client-reports/reports/{report_id}/revoke | Stop the report's share link working, now. | sites.create |
| GET | /v1/client-reports/sinks | Google Sheets and Drive connections that receive clients' reports. | sites.view |
| POST | /v1/client-reports/sinks | Start connecting a Google account to receive one client's reports. | sites.create |
| GET | /v1/client-reports/sinks/google/callback | Where Google returns the browser after consent. Unauthenticated. | کوئی API کلید نہیں |
| DELETE | /v1/client-reports/sinks/{sink_id} | Stop copying reports there and forget the Google access. | sites.create |
| POST | /v1/client-reports/sinks/{sink_id}/sync | Copy the client's latest report there now. | sites.create |
| GET | /v1/public/client-portal/{token} | The client's own page of reports. Unauthenticated. | کوئی API کلید نہیں |
| GET | /v1/public/client-portal/{token}/reports/{report_id} | One of the client's reports, as a web page. Unauthenticated. | کوئی API کلید نہیں |
| GET | /v1/public/client-portal/{token}/reports/{report_id}/pdf | One of the client's reports as a PDF. Unauthenticated. | کوئی API کلید نہیں |
| GET | /v1/public/client-reports/{token} | A shared report, as a web page. Unauthenticated. | کوئی API کلید نہیں |
| GET | /v1/public/client-reports/{token}/pdf | A shared report as a PDF. Unauthenticated. | کوئی API کلید نہیں |