Skip to content
  • There are no suggestions because the search field is empty.

Get List of Reporting Artifacts for a Company API Route

This route will return a list of file names for files generated by the Phin reporting feature

Response Reference

The response is an array of objects, each with the following fields:

Field Type Example
reportLink string https://api.phinsec.io/partners/a9F2YkZ997wCkLJfD6fN/companies/mh1GkfQwW5LEXFbaTwwL/report/performance-report.pdf?year=2023&month=3&day=14&type=weekly
companyId string mh1GkfQwW5LEXFbaTwwL
partnerId string a9F2YkZ997wCkLJfD6fN
reportType string Weekly Performance Report PDF
scope string Mar 1 to Mar 14 2023
fileName string performance-report-2023-3-14.pdf
creationDate string 2023-03-15T03:59:59.999Z

Response Sample

[
{
        "reportLink": "<https://api.phinsec.io/partners/a9F2YkZ997wCkLJfD6fN/companies/mh1GkfQwW5LEXFbaTwwL/report/performance-report.pdf?year=2023&month=3&day=14&type=weekly>",
        "companyId": "mh1GkfQwW5LEXFbaTwwL",
        "partnerId": "a9F2YkZ997wCkLJfD6fN",
        "reportType": "Weekly Performance Report PDF",
        "scope": "Mar 1 to Mar 14 2023",
        "fileName": "performance-report-2023-3-14.pdf",
        "creationDate": "2023-03-15T03:59:59.999Z"
    },
    {
        "reportLink": "<https://api.phinsec.io/partners/a9F2YkZ997wCkLJfD6fN/companies/mh1GkfQwW5LEXFbaTwwL/report/performance-report.pdf?year=2023&month=3&day=15&type=monthly>",
        "companyId": "mh1GkfQwW5LEXFbaTwwL",
        "partnerId": "a9F2YkZ997wCkLJfD6fN",
        "reportType": "Monthly Performance Report PDF",
        "scope": "February 2023",
        "fileName": "performance-report-2023-3-15.pdf",
        "creationDate": "2023-03-16T03:59:59.999Z"
    },
    {
        "reportLink": "<https://api.phinsec.io/partners/a9F2YkZ997wCkLJfD6fN/companies/mh1GkfQwW5LEXFbaTwwL/report/performance-report.pdf?year=2023&month=3&day=15&type=weekly>",
        "companyId": "mh1GkfQwW5LEXFbaTwwL",
        "partnerId": "a9F2YkZ997wCkLJfD6fN",
        "reportType": "Weekly Performance Report PDF",
        "scope": "Mar 1 to Mar 15 2023",
        "fileName": "performance-report-2023-3-15.pdf",
        "creationDate": "2023-03-16T03:59:59.999Z"
    }
]

Error Reference

Code Message Explanation
500 Failed to get reports. Please try again or submit a ticket to Phin Support for assistance. Something went wrong fetching the report inventory of companies. Try again later or contact Phin.