Initiate export request - Fabric

Initiate export request

cURL

curl --request POST \
  --url https://live.copilot.fabric.inc/api-offers/offers-exports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '\n{
  "type": "REDEMPTION",
  "filters": [\
    {\
      "field": "storeId",\
      "value": "store001",\
      "operator": "EQUAL"\
    }\
  ]
}\n'

import requests

url = "https://live.copilot.fabric.inc/api-offers/offers-exports"

payload = {
    "type": "REDEMPTION",
    "filters": [\
        {\
            "field": "storeId",\
            "value": "store001",\
            "operator": "EQUAL"\
        }\
    ]
}
headers = {
    "x-site-context": "<x-site-context>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-site-context': '<x-site-context>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    type: 'REDEMPTION',
    filters: [{field: 'storeId', value: 'store001', operator: 'EQUAL'}]
  })
};

fetch('https://live.copilot.fabric.inc/api-offers/offers-exports', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [\
  CURLOPT_URL => "https://live.copilot.fabric.inc/api-offers/offers-exports",\
  CURLOPT_RETURNTRANSFER => true,\
  CURLOPT_ENCODING => "",\
  CURLOPT_MAXREDIRS => 10,\
  CURLOPT_TIMEOUT => 30,\
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\
  CURLOPT_CUSTOMREQUEST => "POST",\
  CURLOPT_POSTFIELDS => json_encode([\
    'type' => 'REDEMPTION',\
    'filters' => [\
        [\
                'field' => 'storeId',\
                'value' => 'store001',\
                'operator' => 'EQUAL'\
        ]\
    ]\
  ]),\
  CURLOPT_HTTPHEADER => [\
    "Authorization: Bearer <token>",\
    "Content-Type: application/json",\
    "x-site-context: <x-site-context>"\
  ],\
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
    "fmt"
    "strings"
    "net/http"
    "io"
)

func main() {

url := "https://live.copilot.fabric.inc/api-offers/offers-exports"

payload := strings.NewReader("{\n  \"type\": \"REDEMPTION\",\n  \"filters\": [\n    {\n      \"field\": \"storeId\",\n      \"value\": \"store001\",\n      \"operator\": \"EQUAL\"\n    }\n  ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-site-context", "<x-site-context>")
    req.Header.Add("Authorization", "Bearer <token>")
    req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

HttpResponse<String> response = Unirest.post("https://live.copilot.fabric.inc/api-offers/offers-exports")
  .header("x-site-context", "<x-site-context>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"REDEMPTION\",\n  \"filters\": [\n    {\n      \"field\": \"storeId\",\n      \"value\": \"store001\",\n      \"operator\": \"EQUAL\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://live.copilot.fabric.inc/api-offers/offers-exports")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-site-context"] = '<x-site-context>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"REDEMPTION\",\n  \"filters\": [\n    {\n      \"field\": \"storeId\",\n      \"value\": \"store001\",\n      \"operator\": \"EQUAL\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

Possible Responses

• 200
• 400
• 401
• 500

{
  "exportId": "ab50fe48-5da0-4e77-92d1-bb629eedf19e",
  "startedAt": "2023-05-17T21:24:52.398Z",
  "status": "IN_PROGRESS",
  "type": "REDEMPTION",
  "endedAt": "null",
  "totalDataExported": 0,
  "errors": [],
  "filters": [\
    {\
      "field": "storeId",\
      "value": "store001",\
      "operator": "EQUAL"\
    }\
  ]
}

{
  "code": "REQUEST_VALIDATION",
  "message": "Export type not valid."
}

{
  "code": "UNAUTHORIZED",
  "message": "Invalid credentials"
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error."
}

Authorizations

Authorization

• Type: string
• Location: header
• Required: Yes
• Examples:
  • Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Body

• Type: application/json
  • The sample request to initiate data export.

Response

• 200
  • Type: application/json
  • Created
  • Example:

{
  "exportId": "ab50fe48-5da0-4e77-92d1-bb629eedf19e",
  "startedAt": "2023-05-17T21:24:52.398Z",
  "status": "IN_PROGRESS",
  "type": "REDEMPTION",
  "endedAt": "null",
  "totalDataExported": 0,
  "errors": [],
  "filters": [
    {
      "field": "storeId",
      "value": "store001",
      "operator": "EQUAL"
    }
  ]
}