Operations (sample payloads)

Main operations

Convert XLSX to CSV

Convert entire XSLX work sheets to CSV. Sample Input

{
    "file": \{
        "name": "sales_report.xlsx",
        "url": "https://example.com/files/sales_report.xlsx",
        "mime_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
    \},
    "worksheet_names": [
        "Q1 Sales",
        "Q2 Sales"
    ],
    "delimiter": "comma",
    "end_line": "Unix/LF",
    "enclose_quotes": true,
    "include_blank_rows": false
}

Sample Output

{
    "results": [
        \{
            "name": "Q1_Sales.csv",
            "url": "https://example.com/files/Q1_Sales.csv",
            "mime_type": "text/csv",
            "expires": 1623456789
        \},
        \{
            "name": "Q2_Sales.csv",
            "url": "https://example.com/files/Q2_Sales.csv",
            "mime_type": "text/csv",
            "expires": 1623456789
        \}
    ],
    "warnings": [
        \{
            "sheet": "Q2 Sales",
            "message": "Some cells contain formulas that were converted to their calculated values."
        \}
    ]
}

Get data from column

Extract data from a specified column in an XLSX spreadsheet into a text/csv file. Column can be extracted from multiple worksheets. Sample Input

{
    "file": \{
        "name": "sales_data.xlsx",
        "url": "https://example.com/files/sales_data.xlsx",
        "mime_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
    \},
    "worksheet_names": [
        "Q1 Sales",
        "Q2 Sales"
    ],
    "column": 3,
    "blank_cell_value": "N/A"
}

Sample Output

{
    "results": [
        \{
            "name": "extracted_column_data.csv",
            "url": "https://example.com/files/extracted_column_data.csv",
            "mime_type": "text/csv",
            "expires": 1623456789
        \}
    ],
    "warnings": [
        \{
            "sheet": "Q2 Sales",
            "message": "Some cells in the specified column were blank and replaced with 'N/A'"
        \}
    ]
}