# Models ## The ExportStub object ```json {"openapi":"3.1.0","info":{"title":"impact.com API - Export","version":"1.0.0"},"components":{"schemas":{"ExportStub":{"description":"Request body for creating a new export.","required":["type"],"properties":{"type":{"description":"The type of Export that's being requested.","type":"string","enum":["USER","USER_REFERRAL","REFERRAL","USER_REWARD_BALANCE","REWARD_BALANCE","REWARD"]},"format":{"description":"The format of the Export","type":"string","default":"CSV","enum":["CSV","XLSX"]},"name":{"description":"A user-friendly name for this report. Useful for keeping track of which report is which.","type":"string"},"requester":{"description":"Detail on the service or user that requested this report. Defaults to `\"API\"` when not provided.","type":"string","default":"API"},"params":{"description":"Filter parameters for limiting the records returned. Multiple parameters are combined with a logical AND.","type":"object","nullable":true,"properties":{"createdSince":{"description":"Filters for results **created since this date**. Works with `USER`, `USER_REFERRAL`, `REFERRAL`, `USER_REWARD_BALANCE`, `REWARD_BALANCE`.","type":"integer","format":"int64"},"createdBefore":{"description":"Filters for results **created before this date**. Works with `USER`, `USER_REFERRAL`, `REFERRAL`, `USER_REWARD_BALANCE`, `REWARD_BALANCE`.","type":"integer","format":"int64"},"updatedSince":{"description":"Filters for results **updated since this date**. Works with `USER`, `USER_REFERRAL`, `REFERRAL`.","type":"integer","format":"int64"},"updatedBefore":{"description":"Filters for results **updated before this date**. Works with `USER`, `USER_REFERRAL`, `REFERRAL`.","type":"integer","format":"int64"},"createdOrUpdatedSince":{"description":"Filters for results **created or updated since this date**. Useful for incremental exports into a data warehouse. Works with `USER`, `USER_REFERRAL`, `REFERRAL`.","type":"integer","format":"int64"},"createdOrUpdatedBefore":{"description":"Filters for results **created or updated before this date**. Useful for incremental exports into a data warehouse. Works with `USER`, `USER_REFERRAL`, `REFERRAL`.","type":"integer","format":"int64"},"programId":{"description":"The ID of the program that each user's share links and referral code should be populated from. Works with `USER`, `USER_REFERRAL`, `REFERRAL`.","type":"string"},"filter":{"description":"A filter defining which rewards to export. See GraphQL `RewardFilterInput`. Works with `REWARD`.","type":"object"},"at":{"description":"Optional timestamp for exporting the rewards' states at a specific point in time. Works with `REWARD`.","type":"integer","format":"int64"},"fields":{"description":"Settings for which fields are included in the export.","type":"object","properties":{"includeUserStatsFields":{"description":"Whether user stats fields should be included. Works with `USER`.","type":"boolean","default":false},"includeUserFields":{"description":"Whether user fields should be included. Works with `REWARD`.","type":"boolean","default":false},"includeReferralFields":{"description":"Whether referral fields should be included. Works with `REWARD`.","type":"boolean","default":false}}}}}}}}}} ``` ## The Export object ```json {"openapi":"3.1.0","info":{"title":"impact.com API - Export","version":"1.0.0"},"components":{"schemas":{"Export":{"description":"An export record. Includes the original request fields plus the export's `id`, `status`, and timestamps.","allOf":[{"$ref":"#/components/schemas/ExportStub"},{"properties":{"id":{"description":"A unique ID used to track the export. Use this to look up the export's status or download it.","type":"string","readOnly":true},"mailtoEmail":{"description":"Email address to notify when the export completes. Null if not set.","type":"string","nullable":true,"readOnly":true},"status":{"description":"The current state of the export. `PENDING` while queued or running, `COMPLETED` when ready to download, `ABORTED` on unrecoverable error, and `EXPIRED` once the file is no longer available.","type":"string","readOnly":true,"enum":["PENDING","COMPLETED","ABORTED","EXPIRED"]},"dateCreated":{"description":"Unix timestamp (milliseconds) when the export was requested. Never changes.","type":"integer","format":"int64","readOnly":true},"dateCompleted":{"description":"Unix timestamp (milliseconds) when the export finished processing and `status` became `COMPLETED`.","type":"integer","format":"int64","nullable":true,"readOnly":true},"dateExpires":{"description":"Unix timestamp (milliseconds) when the export will expire and no longer be downloadable.","type":"integer","format":"int64","nullable":true,"readOnly":true}}}]},"ExportStub":{"description":"Request body for creating a new export.","required":["type"],"properties":{"type":{"description":"The type of Export that's being requested.","type":"string","enum":["USER","USER_REFERRAL","REFERRAL","USER_REWARD_BALANCE","REWARD_BALANCE","REWARD"]},"format":{"description":"The format of the Export","type":"string","default":"CSV","enum":["CSV","XLSX"]},"name":{"description":"A user-friendly name for this report. Useful for keeping track of which report is which.","type":"string"},"requester":{"description":"Detail on the service or user that requested this report. Defaults to `\"API\"` when not provided.","type":"string","default":"API"},"params":{"description":"Filter parameters for limiting the records returned. Multiple parameters are combined with a logical AND.","type":"object","nullable":true,"properties":{"createdSince":{"description":"Filters for results **created since this date**. Works with `USER`, `USER_REFERRAL`, `REFERRAL`, `USER_REWARD_BALANCE`, `REWARD_BALANCE`.","type":"integer","format":"int64"},"createdBefore":{"description":"Filters for results **created before this date**. Works with `USER`, `USER_REFERRAL`, `REFERRAL`, `USER_REWARD_BALANCE`, `REWARD_BALANCE`.","type":"integer","format":"int64"},"updatedSince":{"description":"Filters for results **updated since this date**. Works with `USER`, `USER_REFERRAL`, `REFERRAL`.","type":"integer","format":"int64"},"updatedBefore":{"description":"Filters for results **updated before this date**. Works with `USER`, `USER_REFERRAL`, `REFERRAL`.","type":"integer","format":"int64"},"createdOrUpdatedSince":{"description":"Filters for results **created or updated since this date**. Useful for incremental exports into a data warehouse. Works with `USER`, `USER_REFERRAL`, `REFERRAL`.","type":"integer","format":"int64"},"createdOrUpdatedBefore":{"description":"Filters for results **created or updated before this date**. Useful for incremental exports into a data warehouse. Works with `USER`, `USER_REFERRAL`, `REFERRAL`.","type":"integer","format":"int64"},"programId":{"description":"The ID of the program that each user's share links and referral code should be populated from. Works with `USER`, `USER_REFERRAL`, `REFERRAL`.","type":"string"},"filter":{"description":"A filter defining which rewards to export. See GraphQL `RewardFilterInput`. Works with `REWARD`.","type":"object"},"at":{"description":"Optional timestamp for exporting the rewards' states at a specific point in time. Works with `REWARD`.","type":"integer","format":"int64"},"fields":{"description":"Settings for which fields are included in the export.","type":"object","properties":{"includeUserStatsFields":{"description":"Whether user stats fields should be included. Works with `USER`.","type":"boolean","default":false},"includeUserFields":{"description":"Whether user fields should be included. Works with `REWARD`.","type":"boolean","default":false},"includeReferralFields":{"description":"Whether referral fields should be included. Works with `REWARD`.","type":"boolean","default":false}}}}}}}}}} ``` ## The ExportList object ```json {"openapi":"3.1.0","info":{"title":"impact.com API - Export","version":"1.0.0"},"components":{"schemas":{"ExportList":{"description":"A paginated list of Export objects.","properties":{"data":{"type":"array","description":"The exports returned in this page.","items":{"$ref":"#/components/schemas/Export"}},"count":{"type":"integer","description":"The number of results in this page. See `totalCount` for the total available."},"totalCount":{"type":"integer","description":"The total number of results available across all pages."}}},"Export":{"description":"An export record. Includes the original request fields plus the export's `id`, `status`, and timestamps.","allOf":[{"$ref":"#/components/schemas/ExportStub"},{"properties":{"id":{"description":"A unique ID used to track the export. Use this to look up the export's status or download it.","type":"string","readOnly":true},"mailtoEmail":{"description":"Email address to notify when the export completes. Null if not set.","type":"string","nullable":true,"readOnly":true},"status":{"description":"The current state of the export. `PENDING` while queued or running, `COMPLETED` when ready to download, `ABORTED` on unrecoverable error, and `EXPIRED` once the file is no longer available.","type":"string","readOnly":true,"enum":["PENDING","COMPLETED","ABORTED","EXPIRED"]},"dateCreated":{"description":"Unix timestamp (milliseconds) when the export was requested. Never changes.","type":"integer","format":"int64","readOnly":true},"dateCompleted":{"description":"Unix timestamp (milliseconds) when the export finished processing and `status` became `COMPLETED`.","type":"integer","format":"int64","nullable":true,"readOnly":true},"dateExpires":{"description":"Unix timestamp (milliseconds) when the export will expire and no longer be downloadable.","type":"integer","format":"int64","nullable":true,"readOnly":true}}}]},"ExportStub":{"description":"Request body for creating a new export.","required":["type"],"properties":{"type":{"description":"The type of Export that's being requested.","type":"string","enum":["USER","USER_REFERRAL","REFERRAL","USER_REWARD_BALANCE","REWARD_BALANCE","REWARD"]},"format":{"description":"The format of the Export","type":"string","default":"CSV","enum":["CSV","XLSX"]},"name":{"description":"A user-friendly name for this report. Useful for keeping track of which report is which.","type":"string"},"requester":{"description":"Detail on the service or user that requested this report. Defaults to `\"API\"` when not provided.","type":"string","default":"API"},"params":{"description":"Filter parameters for limiting the records returned. Multiple parameters are combined with a logical AND.","type":"object","nullable":true,"properties":{"createdSince":{"description":"Filters for results **created since this date**. Works with `USER`, `USER_REFERRAL`, `REFERRAL`, `USER_REWARD_BALANCE`, `REWARD_BALANCE`.","type":"integer","format":"int64"},"createdBefore":{"description":"Filters for results **created before this date**. Works with `USER`, `USER_REFERRAL`, `REFERRAL`, `USER_REWARD_BALANCE`, `REWARD_BALANCE`.","type":"integer","format":"int64"},"updatedSince":{"description":"Filters for results **updated since this date**. Works with `USER`, `USER_REFERRAL`, `REFERRAL`.","type":"integer","format":"int64"},"updatedBefore":{"description":"Filters for results **updated before this date**. Works with `USER`, `USER_REFERRAL`, `REFERRAL`.","type":"integer","format":"int64"},"createdOrUpdatedSince":{"description":"Filters for results **created or updated since this date**. Useful for incremental exports into a data warehouse. Works with `USER`, `USER_REFERRAL`, `REFERRAL`.","type":"integer","format":"int64"},"createdOrUpdatedBefore":{"description":"Filters for results **created or updated before this date**. Useful for incremental exports into a data warehouse. Works with `USER`, `USER_REFERRAL`, `REFERRAL`.","type":"integer","format":"int64"},"programId":{"description":"The ID of the program that each user's share links and referral code should be populated from. Works with `USER`, `USER_REFERRAL`, `REFERRAL`.","type":"string"},"filter":{"description":"A filter defining which rewards to export. See GraphQL `RewardFilterInput`. Works with `REWARD`.","type":"object"},"at":{"description":"Optional timestamp for exporting the rewards' states at a specific point in time. Works with `REWARD`.","type":"integer","format":"int64"},"fields":{"description":"Settings for which fields are included in the export.","type":"object","properties":{"includeUserStatsFields":{"description":"Whether user stats fields should be included. Works with `USER`.","type":"boolean","default":false},"includeUserFields":{"description":"Whether user fields should be included. Works with `REWARD`.","type":"boolean","default":false},"includeReferralFields":{"description":"Whether referral fields should be included. Works with `REWARD`.","type":"boolean","default":false}}}}}}}}}} ``` ## The Error object ```json {"openapi":"3.1.0","info":{"title":"impact.com API - Export","version":"1.0.0"},"components":{"schemas":{"Error":{"properties":{"statusCode":{"description":"The HTTP status code of the error","type":"integer","format":"int32"},"message":{"description":"The human-readable description of what went wrong. Use this to help you debug.","type":"string"},"apiErrorCode":{"description":"A machine error code","type":"string"},"rsCode":{"description":"A secondary machine-readable error code.","type":"string","nullable":true}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://integrations.impact.com/brand-api-reference/advocate-api-reference-v1/reference/export-overview/models.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.