Retrieve a Source

Retrieves a data_source object from your ChartMogul account.

Examples
curl -X GET "https://api.chartmogul.com/v1/data_sources/ds_fef05d54-47b4-431b-aed2-eb6b9e545430" \
     -u YOUR_API_KEY:
ChartMogul::DataSource.retrieve('ds_fef05d54-47b4-431b-aed2-eb6b9e545430')
ChartMogul.DataSource.retrieve(config, 'ds_fef05d54-47b4-431b-aed2-eb6b9e545430');
ChartMogul\DataSource::retrieve("ds_fef05d54-47b4-431b-aed2-eb6b9e545430");
api.RetrieveDataSource("ds_fef05d54-47b4-431b-aed2-eb6b9e545430")
chartmogul.DataSource.retrieve(config, uuid='ds_fef05d54-47b4-431b-aed2-eb6b9e545430')
Result Format
{
  "uuid": "ds_fef05d54-47b4-431b-aed2-eb6b9e545430",
  "name": "In-house billing",
  "system": "Custom",
  "created_at": "2023-01-10T15:34:05.918Z",
  "status": "idle"
}
#<ChartMogul::DataSource:0x007ff9f127d628 
  @uuid="ds_fef05d54-47b4-431b-aed2-eb6b9e545430", 
  @name="In-house billing", 
  @system="Custom",
  @status="idle", 
  @created_at=2023-01-10 11:27:37 UTC,
>
{
  uuid: 'ds_fef05d54-47b4-431b-aed2-eb6b9e545430',
  name: 'In-house billing',
  system: 'Custom',
  created_at: '2023-01-10T15:34:05.918Z',
  status: 'idle',
}
ChartMogul\DataSource::__set_state(array(
  "uuid" => "ds_fef05d54-47b4-431b-aed2-eb6b9e545430",
  "name" => "In-house billing"
  "system" => "Custom",
  "created_at" => "2023-01-10T07:55:08.585Z",
  "status" => "idle",
));
(*chartmogul.DataSource)(0xc042048380)({
  UUID: (string) (len=39) "ds_fef05d54-47b4-431b-aed2-eb6b9e545430",
  Name: (string) (len=16) "In-house billing",
  System: (string) (len=10) "Custom",
  CreatedAt: (string) (len=24) "2023-01-10T12:19:18.346Z",
  Status: (string) (len=4) "idle",
})
<DataSource{
    uuid='ds_fef05d54-47b4-431b-aed2-eb6b9e545430',
    name='In-house billing',
    system='Custom',
    created_at=datetime.datetime(2023, 1, 10, 11, 50, 40, 779000, tzinfo=datetime.timezone.utc),
    status='idle',
}>

The response object contains the following keys:

KeyDescription
uuidThe ChartMogul UUID for the source.
nameThe name of the source.
systemThe billing system. For custom sources, this is Custom. Otherwise, the name of the billing system, e.g. Stripe, Recurly, GoCardless, etcetera.
created_atThe time when the source was created in ChartMogul.
statusThe 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.
Language
Authorization
Basic
base64
: