|
| 1 | +# CustomerInsightsApi |
| 2 | + |
| 3 | +All URIs are relative to *https://api.segmentapis.com* |
| 4 | + |
| 5 | +| Method | HTTP request | Description | |
| 6 | +|------------- | ------------- | -------------| |
| 7 | +| [**createDownload**](CustomerInsightsApi.md#createDownload) | **POST** /customer-insights/download | Create Download | |
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | +## Operation: createDownload |
| 12 | + |
| 13 | +> CreateDownload200Response createDownload(createDownloadAlphaInput) |
| 14 | +
|
| 15 | +Create Download |
| 16 | + |
| 17 | +Create Customer Insights Presigned URLs The rate limit for this endpoint is 1 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information. |
| 18 | + |
| 19 | +### Example |
| 20 | + |
| 21 | +```java |
| 22 | +// Import classes: |
| 23 | +import com.segment.publicapi.ApiClient; |
| 24 | +import com.segment.publicapi.ApiException; |
| 25 | +import com.segment.publicapi.Configuration; |
| 26 | +import com.segment.publicapi.auth.*; |
| 27 | +import com.segment.publicapi.models.*; |
| 28 | +import com.segment.publicapi.api.CustomerInsightsApi; |
| 29 | + |
| 30 | +public class Example { |
| 31 | + public static void main(String[] args) { |
| 32 | + ApiClient defaultClient = Configuration.getDefaultApiClient(); |
| 33 | + |
| 34 | + // Configure HTTP bearer authorization: token |
| 35 | + HttpBearerAuth token = (HttpBearerAuth) defaultClient.getAuthentication("token"); |
| 36 | + token.setBearerToken("BEARER TOKEN"); |
| 37 | + |
| 38 | + CustomerInsightsApi apiInstance = new CustomerInsightsApi(defaultClient); |
| 39 | + CreateDownloadAlphaInput createDownloadAlphaInput = new CreateDownloadAlphaInput(); // CreateDownloadAlphaInput | |
| 40 | + try { |
| 41 | + CreateDownload200Response result = apiInstance.createDownload(createDownloadAlphaInput); |
| 42 | + System.out.println(result); |
| 43 | + } catch (ApiException e) { |
| 44 | + System.err.println("Exception when calling CustomerInsightsApi#createDownload"); |
| 45 | + System.err.println("Status code: " + e.getCode()); |
| 46 | + System.err.println("Reason: " + e.getResponseBody()); |
| 47 | + System.err.println("Response headers: " + e.getResponseHeaders()); |
| 48 | + e.printStackTrace(); |
| 49 | + } |
| 50 | + } |
| 51 | +} |
| 52 | +``` |
| 53 | + |
| 54 | +### Parameters |
| 55 | + |
| 56 | + |
| 57 | +| Name | Type | Description | Notes | |
| 58 | +|------------- | ------------- | ------------- | -------------| |
| 59 | +| **createDownloadAlphaInput** | [**CreateDownloadAlphaInput**](CreateDownloadAlphaInput.md)| | | |
| 60 | + |
| 61 | +### Return type |
| 62 | + |
| 63 | +[**CreateDownload200Response**](CreateDownload200Response.md) |
| 64 | + |
| 65 | +### Authorization |
| 66 | + |
| 67 | +[token](../README.md#token) |
| 68 | + |
| 69 | +### HTTP request headers |
| 70 | + |
| 71 | +- **Content-Type**: application/vnd.segment.v1alpha+json |
| 72 | +- **Accept**: application/vnd.segment.v1alpha+json, application/json |
| 73 | + |
| 74 | + |
| 75 | +### HTTP response details |
| 76 | +| Status code | Description | Response headers | |
| 77 | +|-------------|-------------|------------------| |
| 78 | +| **200** | OK | - | |
| 79 | +| **404** | Resource not found | - | |
| 80 | +| **422** | Validation failure | - | |
| 81 | +| **429** | Too many requests | - | |
| 82 | + |
0 commit comments