Create data export

POST

https://api.schematichq.com/data-exports

POST

/data-exports

import { SchematicClient } from "@schematichq/schematic-typescript-node";
async function main() {
    const client = new SchematicClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.dataexports.createDataExport({
        exportType: "audit-log",
        outputFileType: "csv",
    });
}
main();

{
  "data": {
    "account_id": "string",
    "created_at": "2024-01-15T09:30:00Z",
    "environment_id": "string",
    "export_type": "audit-log",
    "id": "string",
    "output_file_type": "csv",
    "status": "failure",
    "updated_at": "2024-01-15T09:30:00Z",
    "metadata": {
      "export_type": "company-feature-usage",
      "cancel_at_period_end": true,
      "company_ids": [
        "string"
      ],
      "credit_type_ids": [
        "string"
      ],
      "entity_key_definition_ids": [
        "string"
      ],
      "entity_trait_definition_ids": [
        "string"
      ],
      "feature_ids": [
        "string"
      ],
      "has_scheduled_downgrade": true,
      "monetized_subscriptions": true,
      "notification_email_recipient_email_addresses": [
        "string"
      ],
      "plan_id": "string",
      "plan_ids": [
        "string"
      ],
      "plan_version_id": "string",
      "plan_version_unpublished": true,
      "q": "string",
      "sort_order_column": "string",
      "sort_order_direction": "asc",
      "subscription_statuses": [
        "string"
      ],
      "subscription_types": [
        "string"
      ],
      "visible_columns": [
        "plan"
      ],
      "with_entitlement_for": "string",
      "with_subscription": true,
      "without_feature_override_for": "string",
      "without_plan": true,
      "without_subscription": true
    }
  },
  "params": {}
}

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

export_typeenumRequired

Allowed values:

output_file_typeenumRequired

Allowed values:

metadataobjectOptional

Response

Created

dataobject

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error