Sirdata API
Semantic APISirdata CMP - APIAbout Sirdata
  • Sirdata API
  • Overview
    • API Access
    • Sandbox
    • API Updates
  • Authentification
    • Get Token
  • Taxonomy
    • Sirdata Taxonomy
    • IAB Taxonomy
    • 3rd Party Taxonomy
  • A.D.S API
    • About A.D.S
    • Tag integration V1
    • Tag integration V2
    • Test method
    • Segment Access
  • Notification API
    • About Notification API
    • Audience
    • Campaign
    • Webhook endpoint
  • 😎Customer API
    • About Customer API
    • Create storage
    • Create Filter (counting)
    • Create order
    • Segment list
  • Semantic API
  • Sirdata CMP
  • About Sirdata
  • Sirdata API SLA
Powered by GitBook
On this page

Was this helpful?

  1. Customer API

Create order

PreviousCreate Filter (counting)NextSegment list

Last updated 3 years ago

Was this helpful?

When a filter satisfy your need you can create an Order. If you have a rate card associated to your account the status will be automatically set as ACCEPTED when the Order is ready, WAITING_VALIDATION otherwise to be updated be your sales contact. Steps:

  1. Create an order :

  2. Get Order status until status is ACCEPTED (limit 1 request per minute maximum)

  3. Get Order segments statistics

  4. Download accepted Order

let orderRequest = {
  "comment": "my first order",
  "limit": 2000,
  "limit_per_column": {
    "column_index": 4,
    "limits": {
      "01": 30,
      "05": 50
    }
  } 
}
let storageId = 123;
let filterId = 456;

fetch("https://gateway.sirdata.io/api/v1/public/customer/storage/"+storageId+"/filter/"+filterId+"/order", {
  "method": "POST",
  "headers": {
    "Content-Type": "application/json",
    "x-api-token": "XXXXX-XXXXX-XXXXX-XXXXX",
  },
  "body": JSON.stringify(orderRequest)
})
.then(response => {
  console.log(response);
})
.catch(err => {
  console.error(err);
});

If a limit per column has been set you can retrieve the volume per value limit using the Get Order Property table.volume_per_limit contains volume by values. table.row_count is the total volume

😎
https://openapi.sirdata.io/customer/#tag/order/paths/~1customer~1storage~1{id}~1filter~1{filterId}~1order/post
https://openapi.sirdata.io/customer/#tag/order/paths/~1customer~1order~1{id}/get
https://openapi.sirdata.io/customer/#tag/order/paths/~1customer~1order~1{orderId}~1data/get
https://openapi.sirdata.io/customer/#tag/order/paths/~1customer~1order~1{id}/get