Back to ChartMogulAPI referenceGuides and tutorialsSupportContact

Create a Data Source

post https://api.chartmogul.com/v1/data_sources

Creates a data_source object for importing data into ChartMogul.

Examples

curl -X POST "https://api.chartmogul.com/v1/data_sources" \
     -u YOUR_API_KEY: \
     -H "Content-Type: application/json" \
     -d '{ 
          "name": "In-house billing"
         }'

ChartMogul::DataSource.create!(
  name: 'In-house billing'
)

ChartMogul.DataSource.create(config, {
   "name": "In-house billing"
}, function(err, res) {
   // asynchronously called
});

<?php

ChartMogul\DataSource::create([
    "name" => "In-house billing"
]);
?>

api.CreateDataSource("In-house billing")

chartmogul.DataSource.create(config, data={
    "name": "In-house billing"
})
Result Format
{
    "uuid": "ds_fef05d54-47b4-431b-aed2-eb6b9e545430",
    "name": "In-house billing",
    "system": "Custom",
    "created_at": "2016-01-10T15:34:05Z",
    "status": "idle"
}

#<ChartMogul::DataSource:0x007ff9f127d628 
@name="In-house billing", 
@uuid="ds_fef05d54-47b4-431b-aed2-eb6b9e545430",
@system="Custom",
@status="idle", 
@created_at=2016-06-27 11:27:37 UTC
>

{
    "uuid": "ds_fef05d54-47b4-431b-aed2-eb6b9e545430",
    "name": "In-house billing",
    "system": "Custom",
    "created_at": "2016-01-10T15:34:05Z",
    "status": "idle"
}

ChartMogul\DataSource::__set_state(array(
   "uuid" => "ds_fef05d54-47b4-431b-aed2-eb6b9e545430",
   "status" => "idle",
   "system" => "Custom",
   "created_at" => "2016-12-27T07:55:08.585Z",
   "name" => "In-house billing"
));

(*chartmogul.DataSource)(0xc042048380)({
 UUID: (string) (len=39) "ds_d051800c-edf8-11e6-9a33-03ed88a413a7",
 Name: (string) (len=16) "In-house billing",
 CreatedAt: (string) (len=24) "2017-02-08T12:19:18.346Z",
 Status: (string) (len=4) "idle",
 System: (string) (len=10) "Custom"
})

<DataSource{
  created_at=datetime.datetime(2017, 2, 8, 11, 50, 40),
  name='abc',
  status='idle',
  uuid='ds_d0235fc8-edf4-11e6-af62-0b4bbe8d71a4',
  system='Custom'}>

In the response, the JSON object contains the following data:

  • uuid - The UUID of the data_source object generated by ChartMogul.
  • name - The unique name of the data source as specified by you.
  • system - The type of system from which customer billing data is imported using this data source. For example, Stripe, Recurly, GoCardless, Chargify, Custom, and so on.
  • created_at - The time when this data source was created in the ChartMogul system.
  • status - The current status of the data import into ChartMogul. For data sources based on integrations maintained by ChartMogul (ie. Stripe, Braintree, etc.), if there is no data then status will be never_imported. If there is data that is being processed then status will be importing. If all data has been processed then status will be import_complete. For data sources based on our Custom data source, if data is currently being processed then status will be working and if there's no data being processed then status will be idle.

📘

Creating data sources for integrations maintained by ChartMogul

You can create data sources for integrations maintained by ChartMogul, ie. Stripe, Braintree, Recurly, Chargify and PayPal, directly within your ChartMogul account at Data platform > Home. You can use this endpoint only to create data sources that are based on our Custom data source.

Language