List Sources

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

Lists all data_source objects in your ChartMogul account.

curl -X GET "https://api.chartmogul.com/v1/data_sources" \
     -u YOUR_API_KEY:

ChartMogul::DataSource.all

ChartMogul.DataSource.all(config);

ChartMogul\DataSource::all();

api.ListDataSources()

chartmogul.DataSource.all(config)

{
  "data_sources": [
    {
      "uuid": "ds_fef05d54-47b4-431b-aed2-eb6b9e545430",
      "name": "In-house billing",
      "system": "Custom",
      "created_at": "2023-01-10T15:34:05.437Z",
      "status": "idle"
    },
    {
      "uuid": "ds_ade45e52-47a4-231a-1ed2-eb6b9e541213",
      "name": "Enterprise billing connection",
      "system": "Custom",
      "created_at": "2023-01-09T10:14:15.223Z",
      "status": "idle"
    }
  ]
}

#<ChartMogul::DataSources:0x00000003ed9d58
  @data_sources=[
    #<ChartMogul::DataSource:0x007ff9f237ba88
      @uuid="ds_fef05d54-47b4-431b-aed2-eb6b9e545430",
      @name="In-house billing", 
      @system="Custom",
      @created_at=2023-01-10 15:34:05 UTC,
      @status="idle", 
    >, 
    #<ChartMogul::DataSource:0x007ff9f2379b20 
      @uuid="ds_ade45e52-47a4-231a-1ed2-eb6b9e541213", 
      @name="Enterprise billing connection", 
      @system="Custom",
      @created_at=2023-01-09 10:14:15 UTC,
      @status="idle",
    >
  ]
>

{
  data_sources: [
    {
      uuid: "ds_fef05d54-47b4-431b-aed2-eb6b9e545430",
      name: "In-house billing",
      system: "Custom",
      created_at: "2023-01-10T15:34:05.437Z",
      status: "idle",
    },
    {
      uuid: "ds_ade45e52-47a4-231a-1ed2-eb6b9e541213",
      name: "Enterprise billing connection",
      system: "Custom",
      created_at: "2023-01-09T10:14:15.223Z",
      status: "idle"
    }
  ]
}

Doctrine\Common\Collections\ArrayCollection::__set_state(array(
  0 => ChartMogul\DataSource::__set_state(array(
    "uuid" => "ds_fef05d54-47b4-431b-aed2-eb6b9e545430",
    "name" => "In-house billing",
    "system" => "Custom",
    "created_at" => "2023-01-10T15:34:05.437Z",
    "status" => "idle",
  )),
  1 => ChartMogul\DataSource::__set_state(array(
    "uuid" => "ds_ade45e52-47a4-231a-1ed2-eb6b9e541213",
    "name" => "Enterprise billing connection",
    "system" => "Custom",
    "created_at" => "2023-01-09T10:14:15.223Z",
    "status" => "idle",
  )),
));

(*chartmogul.DataSources)(0xc0420c8ba0)({
  DataSources: ([]*chartmogul.DataSource) (len=2) {
    (*chartmogul.DataSource)(0xc042008440)({
      UUID: (string) (len=39) "ds_dc5e3618-edfa-11e6-9e29-f709b6341791",
      Name: (string) (len=16) "In-house billing",
      System: (string) (len=10) "Custom",
      CreatedAt: (string) (len=24) "2023-01-10T15:34:05.437Z",
      Status: (string) (len=4) "idle",
    }),
    (*chartmogul.DataSource)(0xc00002dce0)({
      UUID: (string) (len=39) "ds_ade45e52-47a4-231a-1ed2-eb6b9e541213",
      Name: (string) (len=27) "Enterprise billing connection",
      System: (string) (len=10) "Custom",
      CreatedAt: (string) (len=24) "2023-01-09T10:14:15.223Z",
      Status: (string) (len=4) "idle",
    })
  }
})

DataSources(data_sources=[
  <DataSource{
    uuid="ds_dc5e3618-edfa-11e6-9e29-f709b6341791",
    name="In-house billing",
    system="Custom",
    created_at=datetime.datetime(2023, 1, 10, 15, 34, 57),
    status="idle",
  }>,
  <DataSource{
    uuid="ds_ade45e52-47a4-231a-1ed2-eb6b9e541213",
    name="Enterprise billing connection",
    system="Custom",
    created_at=datetime.datetime(2023, 1, 9, 10, 14, 15),
    status="idle",
  }>
])

Query parameters

name string: The name of the data source. eg. My data source
system string: The type of system of the data sources. For example, Stripe, Recurly, or Custom.

Response

In the response, the data_sources field contains an array of source (data source) objects that you've created, with each item containing the same data as the "Retrieve a Source" endpoint. That is:

uuid

The ChartMogul UUID for the source.

name

The name of the source.

system

The billing system. For custom sources, this is Custom. Otherwise, the name of the billing system, e.g. Stripe, Recurly, GoCardless, etc.

created_at

The time when the source was created in ChartMogul.

status

The current status of the source.

For custom sources, this can be:

working when there is currently data being processed
idle when no data is being processed.

For ChartMogul-maintained integrations, this can be

never_imported when there is no data at all
importing when import is in progress
import_complete when the import is completed.