Request Payload

This page illustrates the format of the request json data

In order to use the endpoints to convert your json data into either a .pptx file or a PPTX Builder project you need to structure your json in a certain way. Below is an example of that structure.

You can use the example below as a base for creating your own json payload.

{
  "base_settings": {},
  "global_chart_settings": {},
  "custom_obj": {},
  "body": [{
    "custom_obj" : { "internal_param" : 123 }, 
    "slide": {
      "id": "desired-unique-id",
      "table_text": "Demo",
      "question_text": "What is Demo?",
      "base_text": "A Demo text!",
      "layout": {
        "slide_master_index": 0,
        "slide_layout_index": 0
      }
    },
    "charts": [{
      "rows": ["Yes", "No"],
      "columns": [{
        "text": "Work in Progress",
        "items": [{
          "text": "Does it work?",
          "base": 3.0,
          "data": [2.0, 1.0]
        }]
      }],
      "view_settings": {
        "chart_type": "bar",
        "placeholder_index": 0
      }
    }, {
      "rows": ["Maybe", "Other"],
      "columns": [{
        "text": "Work is done",
        "items": [{
          "text": "Does it work?",
          "base": 5.0,
          "data": [3.0, 2.0]
        }]
      }],
      "view_settings": {
        "chart_type": "bar",
        "placeholder_index": 0
      }
    }]
  }]
}

Continue to the next sections to dive into each of the sections in the request json data.

Last updated